百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术文章 > 正文

如何快速写出高质量文档(Markdown篇)

zhezhongyun 2025-02-13 15:12 33 浏览

Markdown是什么

Mark down的英文直译就是记下的意思(中间有空格),作为一种轻量级的『标记语言』目前已被广泛使用,各大主流的平台和编辑器都有做支持,尤其是Github上使用Readme.md文件作为项目简介的文章就是使用了markdown语言,而这门“语言”无论是学习还是使用起来都非常的简单!


正如作者所说的那样:

Markdown旨在尽可能地易于阅读和易于编写。

-- John Gruber


目前支持了该语言格式的平台包括:

  • github/gitbook
  • wordpress
  • csdn
  • 简书
  • 有道云笔记


了解一点点的HTML

Markdown语法的主要目标是用作web编写的格式。它的灵感来源于纯文本电子邮件。

但是Markdown并不是HTML的替代,它远比HTML小的多,仅实现了HTML语言中的一小部分,它可以用更简单的方式(一种纯文本的方式),来达到HTML显示的效果。


注:如果你看到了HTML语法就感到了困惑的话,那么你大可不必阅读这一部分的内容,因为就算你不了解也没有任何问题。


在浏览器里查看到的网络,使用的是HTML超文本标记语言来实现的,主要是通过一些列的标签来统一文档的格式,涵盖了文字、图形,动画、声音、表格、连接等。

在 HTML5 中还有很多更加丰富的标签类型可以使用,注意哦,这些标签,在markdown文档里,都可以直接使用。但有个别需要注意的地方,在内联HTML模块里我们详细讲述。


然而,markdown却不用像HTML标签那样书写,而是使用一些简单的符号标记即可。(最终他们会输出成HTML标记)


更简洁也更便捷的书写方式

使用Markdown语言的优点主要包括:


关于作者

而Markdown的作者 John Gruber 是一个什么样的人呢?他是一个作家,UI设计师!(也是一个软件工程师)


John Gruber出生于费城,是德雷克塞尔大学计算机科学专业毕业的,在2002年开设了Daring Fireball(主要评论苹果产品、策略,有时也发布一些自己开发的软件)。2004年设计开发了Markdown语言。


Markdown语法速记

一篇文章的构成,主要有 封面,目录,标题,正文,脚注 等构成,在Office的Word里还有更加强大的页眉 页脚,页码 的显示,甚至可以添加 批注。而我们在Markdown里需要关注的并不是一篇word文档的编辑工作(尽管它可以导出成为doc文件),我们更加关注在浏览器里,一个网页里文章的基本展现效果,因此,我们暂时不考虑页眉页脚页码批注等效果,也不用考虑封面。其中对正文的支持,又可以细分到很多表现形式,比如表格、图片等,以下列出了所有支持的段落和格式效果。


(对每个标记的详细说明见文章 《高逼格写作Markdown标记详解》


常用编辑器推荐

Mou

  • 由国人开发的,支持实时预览,但仅支持苹果系统。可以说是目前最好的免费Markdown编辑器,对汉字兼容性非常好;
  • 提供语法高亮、在线预览、同步滚动、全屏模式;
  • 支持自动保存、自动匹配;
  • 允许自定义主题等;
  • 软件网址:http://25.io/mou/
  • 软件预览:



Typora

  • 目前笔者最喜欢用的编辑器,支持 Windows ,MacOS X ,以及 Linux 平台;
  • 特点是真正的即时预览,单窗口展示,编写完后自动识别并直接展示出效果来;
  • 支持源码模式,点击切换后可以仅书写而不展示效果;
  • 支持多种主题,非常方便地扩展不同的样式,以达到不一样的显示效果;
  • 菜单操作非常便捷,如果你忘了如何做标记,那么直接使用菜单里的选项生成即可;
  • 支持导出PDF,HTML,Office Word,图像等多种格式;
  • 软件网址:https://www.typora.io/
  • 软件预览:



Atom

  • 专门为程序员推出的文本编辑器,支持实时预览,支持 Windows ,MacOS X ,以及 Linux 平台;
  • 需要双屏开启预览模式,并非仅为Markdown而设计,是一个可以做变成IDE的软件,由github平台出品;
  • 支持CSS,HTML,JavaScript等网页编程语言,支持宏定义;
  • 支持语义输入模式,比如输入code即开启代码模式;
  • 软件网址:https://atom.io/
  • 软件预览:



Haroopad

  • 来自韩国的一款流程编辑器,支持 Windows ,MacOS X ,以及 Linux 平台;
  • 特点是主题样式特别丰富,语法支持无数种(几乎你能想到的所有)编程语言高亮,Linux用户比例非常高,同时还是一个开源免费的软件;
  • 支持导出HTML,PDF等文件格式;
  • 特别地,支持数学公式和流程图功能;
  • 软件网址:http://pad.haroopress.com/user.html
  • 软件预览:



其他常用的软件

Cmd Markdown

  • 支持3大平台,也有web在线的支持;
  • 软件网站:https://www.zybuluo.com/mdeditor

Byword

  • 主要是苹果平台支持,包括移动端(Mac,iPhone,iPad),但是是收费的;
  • 软件网站:https://bywordapp.com/

CuteMarkEd

  • 支持3大平台,开源免费,提供实时HTML预览,数字表达式功能;
  • 软件网站:https://cloose.github.io/CuteMarkEd/

Dillinger

  • 国外的网站,支持web在线制作,支持保存到Dropbox、bitbucket、github、google drive等平台;
  • 软件网站:https://dillinger.io/

Marxico

  • 马克飞象,有桌面版,Chrome App插件,web集成版,可以直接把文本保存到印象笔记;
  • 软件网址:http://marxi.co/

相关推荐

JavaScript中常用数据类型,你知道几个?

本文首发自「慕课网」,想了解更多IT干货内容,程序员圈内热闻,欢迎关注!作者|慕课网精英讲师Lison这篇文章我们了解一下JavaScript中现有的八个数据类型,当然这并不是JavaScr...

踩坑:前端的z-index 之bug一二(zh1es前端)

IE6下浮动元素bug给IE6下的一个div设置元素样式,无论z-index设置多高都不起作用。这种情况发生的条件有三个:1.父标签position属性为relative;2.问题标签无posi...

两栏布局、左边定宽200px、右边自适应如何实现?

一、两栏布局(左定宽,右自动)1.float+margin即固定宽度元素设置float属性为left,自适应元素设置margin属性,margin-left应>=定宽元素宽度。举例:HTM...

前端代码需要这样优化才是一个标准的网站

  网站由前端和后端组成,前端呈现给用户。本文将告诉您前端页面代码的优化,当然仍然是基于seo优化的。  就前端而言,如果做伪静态处理,基本上是普通的html代码,正常情况下,这些页面内容是通过页面模...

网页设计如何自学(初学网页设计)

1在Dreamweaver中搭建不同的页面,需要掌握HTML的语句了,通过调整各项数值就可以制作出排版漂亮的页面,跟着就可以学习一些可视化设计软件。下面介绍网页设计如何自学,希望可以帮助到各位。Dre...

1、数值类型(数值类型有)

1.1数据类型概览MySQL的数据类型可划分为三大类别:数值类型:旨在存储数字(涵盖整型、浮点型、DECIMAL等)。字符串类型:主要用于存储文本(诸如CHAR、VARCHAR之类)。日期/...

网页设计的布局属性(网页设计的布局属性是什么)

布局属性是网站设计中必不可少的一个重要的环节,主要用来设置网页的元素的布局,主要有以下属性。1、float:该属性设置元素的浮动方式,可以取none,left和right等3个值,分别表示不浮动,浮在...

Grid网格布局一种更灵活、更强大的二维布局模型!

当涉及到网页布局时,display:flex;和display:grid;是两个常用的CSS属性,它们都允许创建不同类型的布局,但有着不同的用法和适用场景。使用flex布局的痛点当我们使...

React 项目实践——创建一个聊天机器人

作者:FredrikStrandOseberg转发链接:https://www.freecodecamp.org/news/how-to-build-a-chatbot-with-react/前言...

有趣的 CSS 数学函数(css公式)

前言之前一直在玩three.js,接触了很多数学函数,用它们创造过很多特效。于是我思考:能否在CSS中也用上这些数学函数,但发现CSS目前还没有,据说以后的新规范会纳入,估计也要等很久。然...

web开发之-前端css(5)(css前端设计)

显示控制一个元素的显示方式,我们可以使用display:block;display:inline-block;display:none;其中布局相关的还有两个很重要的属性:display:flex;和...

2024最新升级–前端内功修炼 5大主流布局系统进阶(分享)

获课:keyouit.xyz/14642/1.前端布局的重要性及发展历程前端布局是网页设计和开发的核心技能之一,它决定了页面元素如何组织和呈现。从早期的静态布局到现代的响应式布局,前端布局技术经历了...

教你轻松制作自动换行的CSS布局,轻松应对不同设备!

在网页设计中,自动换行的CSS布局是非常常见的需求,特别是在响应式设计中。它可以让网页内容自动适应不同屏幕尺寸,保证用户在不同设备上都能够获得良好的浏览体验。本文将介绍几种制作自动换行的CSS布局的方...

晨光微语!一道 CSS 面试题,伴你静享知识治愈时光

当第一缕阳光温柔地爬上窗台,窗外的鸟鸣声清脆悦耳,空气中弥漫着清新的气息。在这宁静美好的清晨与上午时光,泡一杯热气腾腾的咖啡,找一个舒适的角落坐下。前端的小伙伴们,先把工作的疲惫和面试的焦虑放在一边,...

2023 年的响应式设计指南(什么是响应式设计优缺点)

大家好,我是Echa。如今,当大家考虑构建流畅的布局时,没有再写固定宽度和高度数值了。相反,小编今天构建的布局需要适用于几乎任何尺寸的设备。是不是不可思议,小编仍然看到网站遵循自适应设计模式,其中它有...