如何写一个漂亮的Markdown

作为一个技术人员，善于利用工具提升生产效率是一个合格的技术人员的基本修养，也是提升效率的一个重要途径。作为一个程序员，有许许多多的工具来提升生产效率，使用规范化和大统一的规则规范是与优秀程序员世界接轨、交流和孜孜不倦的追求。

这里，想写很多工具和方法。但是，这里想先讲讲怎么将自己的内容完美呈现出来，让更多的人能够理解自己的思想。

程序员的世界里，原本表达思想的文件格式是文本格式。但是毫无格式的文本，讲真，看起来有点累。看到那个RFC文档动则几十上百页的黑白同字号文本内容，让人看得眼花缭乱，昏昏欲睡。幸好，我们程序员自己动手丰衣足食，给自己的发明了Markdown格式的文档来自我满足。

首先简单介绍几种写Markdown文件的工具：

vscode 万能编辑器vscode，是一个手头上最容易获取，原生支持Markdown格式。不过，原生的预览不太美观，我更喜欢安装一个 Markdown Preview Enhanced 的预览插件。分左右屏，左边编写内容，右边预览渲染格式。

typora 专门为写Markdown而生的，跟上面的不一样，它是本地编写并同时进行渲染。有人喜欢，但我不太适应。

作业部落 作业部落是一个在线的网页编辑器，跟vscode使用体验差不多，也是分屏的。内容直接保存在云端，渲染很漂亮！

对于个人来说，使用还算方便，但对于有隐私内容不便泄漏的，可能不太适合。另外，这个网站是个人搭建的，稳定性可能不算特别高，我使用期间就遇到过两次网站挂掉的情况。

其他 其他的编辑器还有很多，如马克飞象、印象笔记、GitHub，以及现代的各种IDE基本上都支持Markdown的编写预览。选择一款适合自己的即可。

Markdown 是一种轻量级标记语言，它允许人们使用易读易写的纯文本格式编写文档，然后转换成格式丰富的HTML页面。 —— 维基百科

Markdown格式是为程序员而生，对代码、图片、超链接、列表、层级结构、表格有很好的设计。甚至还有很强的扩展能力，例如安装相应的插件后，对Latex公式、流程图、目录都可以很好的显示和表达。

Markdown格式也可以很容易的转换为其他的格式，例如HTML，PDF格式等。总之，怎么夸赞都不为过。

基本格式格式规范参考以下链接，我这里就不罗列一遍了。

一定要层级结构清晰，逻辑清楚。这点是最重要的。使用# ## 等表示标题，标题层级结构要一致、逻辑恰当。标题结构最好不要超过4级，大部分人类能理解的最多的层级结构差不多就在三四级的样子。

代码一定要使用重音符（键盘上数字1左边的键），并在三个重音符的后边附上代码的语言，例如bash｜c｜cpp (C++)｜cs (C#)｜objectivec (Objective-C)｜swift｜java｜css｜xml (HTML, XML)｜javascript｜coffeescript｜json｜php｜perl｜python｜ruby｜sql｜mathematica｜matlab｜r｜scala｜lisp｜scheme｜markdown｜tex 等等。

例如：

会被渲染为：

是不是明显漂亮多了？

可以适当嵌入一些图片，让文档更生动。 对我这个懒人来说，我这点做得不够，不喜欢截图并保存。使用外部图片链接的方式不如直接保存图片到本地进行链接来的靠谱，因为很难说某一天，你的这个图片链接失效了。到时候哭都来不及。

分清楚有序列表和无序列表。

公式最好使用LaTeX来编辑，保存文本总是比保存图片来的稳定和可靠。流程图、甘特图等也是一样，参考菜鸟教程 不过，这些都有一定的学习成本。但，大部分程序员其实这些用不太到，不学也关系不大。

列举重要的几点如下：

颜色表示 $\color{red}{红色}$ -> $\color{red}{红色}$

待办事项

渲染效果如下：