Markdown简介
Markdown是什么
Markdown的一种轻量级的标记语言,它是由John Gruber和Aaron Swartz创建。
所谓“标记语言”,就是通过一些简单的标记,来告诉渲染引擎应该对标记的文本显示出加粗、斜体、一级标题、二级标题等的效果。比如,用两个星号 **
包裹住文字,表示被包裹的文字要加粗。
在以往,我们写文档需要先打开word(速度有多慢大家都知道),然后在word里写文档,写完后要在工具栏和正文内容来回点,设置一二三四级标题,设置加粗、斜体、列表,等等。操作既费时又复杂。
而用Markdown书写一篇文档,你只需要用键盘一通输入,连鼠标都可以不动用就完成。这里所说的完成,是包括把文档的格式(设置一二三四级标题,设置加粗、斜体、列表,等等)也调好了。
由于仅需要输入文本,不需要调整格式或其他复杂的操作,用Markdown书写的文档的速度可以非常快和简易,能够极大地提高我们书写文档的效率。
谁适合用Markdown
并不是所有人都适合使用Markdown来书写文档的。如果说使用Markdown不能显著地提高效率、提高文档的可读性,或者Markdown的语法不能满足你复杂的样式要求,那么你应该考虑用其他的方式书写文档。
下面给出一些适用Markdown书写文档的用户或场景:
- 程序员。毫无疑问,Markdown就是为程序员量身定做的书写方式;甚至于,如果一个程序员不会用Markdown来撰写文档(尤其是技术文档),那么这个程序员很可能不是一个合格的程序员。
- 技术文档。操作指引、流程指引、接口文档、技术说明、培训资料等等都可以用Markdown来书写。
- 论述性文章。论述性文章因为论点鲜明、结构清晰,非常适合用Markdown来书写(当然,前提是对版式要求不太高)
- 新闻。
有一些用户或场景,是很明确不应该使用Markdown来撰写文档的:
- 公文、合同。公文和合同往往对格式和内容有严苛的要求,而Markdown的短板正好是这个,因此不适用于公文的书写。
- 活泼的文章。一些比较活泼的文章(如团队活动海报、活动推广)的排版比较灵活,不适合用Markdown来书写。
- 学术论文。尽管Markdown支持书写复杂的数学表达式,但仍然不容易记忆和书写,不太建议使用Markdown来书写。
Markdown编辑器和软件简介
三种类型的编辑器
纯文本编辑器 Markdown书写文档的优势在于,你甚至只需要用一个记事本(或者VIM之类的工具)就可以开始文档的书写。
带预览功能的编辑器 这类编辑器的输入框和纯文本编辑器一样,只是允许你输入文本。不同之处在于,你可以点击“预览”按钮,来查看你输入的内容渲染后的样子。
实时预览的编辑器 这类编辑器一般是两栏模式,左边是输入区域,即书写Markdown文档的地方;在你输入的过程中,右边会实时显示你输入文档渲染的样子。
实时预览的编辑器的体验会比较好,因此在这里所推荐的编辑器大多是这类的。
OneLib智库
可登录OneLib智库注册账户去体验,我的所有笔记都是用这个来写的。 onelib.biz/blog
为知笔记
一个跨平台的知识管理软件。它支持Windows、MacOS,支持iPhone、Android。它支持富文本编辑器、Markdown编辑器,甚至直接书写html(支持javascript)文档,支持多终端云同步。
有道云笔记
一个跨平台的知识管理软件。它支持Windows、MacOS,支持iPhone、Android。它支持富文本编辑器、Markdown编辑器,支持多终端云同步。
下载: note.youdao.com/download.ht…
马克飞象
马克飞象是一款专为印象笔记(Evernote)打造的Markdown编辑器,通过精心的设计与技术实现,配合印象笔记强大的存储和同步功能,带来前所未有的书写体验。
地址:maxiang.io/#
MarkdownPad(windows)
MarkdownPad是Windows下的一个多功能Markdown编辑器。
Mou(MacOS)
Mou 是 Mac 上的 Markdown 编辑器,两栏界面,直观清爽,功能简洁到位。不过收费!
下载:25.io/mou/
简书(Web)
一个专注写作的社区,它支持Markdown编辑器。
Typora
Typora 是一款简约派 Markdown 编辑器,支持「所见即所得」的编辑模式,少数派上推荐过很多次,大家应该不陌生。
一些相关常识
图床
Markdown插入图片是插入的地址(url或者本地路径)。你可以选择把图片存储在网络上,也可以存储在本地。
如果存储在本地,则在其他电脑就无法显示。因此,为了保证你写的markdown文档在任何地方都能正常阅读,你需要一个“图床”来存放你的图片。
所谓“图床”,就是是一些网站提供的图片存储和读取服务,即允许你上传图片到他们的服务器中、并允许你根据url读取这些图片。比较常用的图床如“七牛云”,“SM.MS”等。
在OneLib智库,我们的OneLib智库服务器就是一个“图床”,你所写的文档可以直接上传到OneLib智库服务器中,免去了插入图片的麻烦。
语法简介
标题
在word中,你需要设置一级、二级、三级等标题,而Markdown语法是用井号 #
来标记的。一级标题就用一个井号#
,二级标题就用两个井号#
,以此类推。
加粗 / 斜体 / 删除线
前后各两个星号 **
包裹要加粗的文字;
斜体用一个星号*
包裹
前后两个波浪号~~
包裹要删除的文字,如 ~~删除这个文字~~
无序列表
在行首加 +
或 -
和一个空格,如 + 问题1
有序列表
在行首加 数字、 .
和一个空格,如 1. 问题1
引用
在行首加英文右括号 >
和一个空格,如> OneLib智库
代码块
第一行和最后一行加上 ```
,如:
第一行最后写上语言名称(可不写)
链接和图片
中括号中输入文本,小括号中输入地址;图片在最前面加一个感叹号 !
如 
备注:在OneLib智库的编辑器中,可以直接复制图片或截屏,点击需要插入的位置后按快捷键Ctrl+V即可粘贴,编辑器会自动把图片上传到OneLib智库服务器中,并以Markdown语法插入指定位置。
表格
表格的书写比较复杂,首先:
- 第一行书写表头。用竖线
|
分割 - 第二行书写表格的对齐方式。列与列之间用竖线
|
分割,里面以三个横线---
填充。每一列用冒号:
表示对齐方式,如:|:--|
表示左对齐|:--:|
表示居中|---:|
表示右对齐
- 第三行开始书写实际数据。每一列与表头对应即可。列与列之间用竖线
|
分割。
注意事项和原则
注意事项
换行 由于Markdown编辑器的解析方式可能不同,不同标记的段落最好换一行,例如:
- 标题与任何内容
- 正文与代码块
空格
无序列表的标记后面要加一个空格,例如:
有序列表: 1. 有序列表元素
里的 1.
与 有序列表元素
之间有一个空格
书写原则
内容优先 Markdown不需要你注重排版,所以你应该关注内容本身。
逻辑清晰 逻辑是一篇文档的骨架,我强烈建议大家在书写文档之前把文档提纲先写好。
图文并茂 在语言文字无法描述清楚的时候,要配上图片(流程图、结构图等),以增强文档的可读性。
更多关于Markdown的书写规则,可参考这篇文章:《Markdown文档书写规范》www.onelib.biz/blog/a/5fe7…