使用Markdown写文档

Posted 2020-07-17

转载于：http://blog.csdn.net/xiahouzuoxin/article/details/19752603

Markdown是一种网络书写语言，其目标是实现易读易写，且兼容html语言。Markdown的流行得益于Github和Stackoverflow，Stackoverflow的代码块以及Github上的README.md文件格式都是通过Markdown表现的。从这里您可以很直观的看到Markdown的效果：https://github.com/adam-p/markdown-here。

使用Markdown可以书写自由书籍，关于此，您可以参看文章用Markdown来写自由书籍-开源技术的方案，开源书和开源技术-Markdown篇一文也介绍了一些Markdown与开源书和开源技术之间的渊源。已经有一些开源书籍使用Markdown书写了，亚嵌教育的开源书籍源码开放学ARM、蒋鑫老师的GotGithub一书，这些开源书籍都给学习者提供很大帮助。Markdown书写已经是一种开源精神体现。好了，既然Markdown与自由书写这么默契，我们怎么用Markdown来写自己的README.md，自己的博客甚至自己的开源书籍呢？

这里有一份Markdown的语法，http://wowubuntu.com/markdown/，从这里（https://gitcafe.com/riku/Markdown-Syntax-CN/blob/master/syntax.md）看可能更直观。Markdown语法是如此简单，以至于还不到1000行就描述完了。初学者您可以参考献给写作者的Markdown新手指南。Github的Markdown语法大部分都与传统Markdown语法一样，这您可以看看markdown-basics，但也有些扩展，扩展内容在文档GitHub Flavored Markdown中。

在使用Markdown过程中，您也许还需要一个时时显示Markdown文档预览的工具，这方面的工具有很多，这里推荐几个在线的Markdown文档编辑器：

1. Dillinger:       http://dillinger.io/

2. StackEdit:    https://stackedit.io/

3. 印象笔记:     http://maxiang.info/ 

“免费Markdown写作工具简评”一文提供了有关于Markdown文档编辑器的更多信息。

谷歌浏览器貌似也有Markdown的预览插件（https://github.com/volca/markdown-preview），这样您就可以用记事本编辑，用浏览器预览了。

印象笔记也有Chrome的扩展，可在商店搜素“马克飞象”。

我们说Markdown是为了书写自由电子书，那么Markdown如何生成pdf或html格式的文档呢？我们可以借助Markdown文档编辑器的功能，StackEdit就能胜任，使用StackEdit左上角的菜单，save as..就可以做到。

还有一款集编辑与Markdown预览于一身的不错工具Everedit，国产的哦..

最后，你可以在Github上找到这篇文章的Markdown版本：https://github.com/xiahouzuoxin/notes/blob/master/README.md。