注册

【心得分享】关于MarkDown文档的撰写

**为什么要用 MarkDown 写文档**


最开始接触 MarkDown 其实是在研究各种 Wiki 系统时看到的。因为不明白 MarkDown 是什么东东,所以就手贱的搜索了一下。

然后,本能地学习它的语法结构。刚上手时,感觉相当不习惯。从我的个人感受来说有以下几点:

不熟悉 MarkDown 的语法,总是要查手册。(又要记好多东西啊……)
没有好用的工具,和语法高亮。(和 txt 看着差不多……)
没有所见即所得来的方便。(还不如 Word 嘛……)


接受 MarkDown 是在观察了 GitHub 上的表现之后,而且发现了很多方便的地方:

git、svn 等工具的比对功能还是相当方便的。(这是主要原因……)
很多开源工具支持解析MarkDown语法(我用 Adobe 的 Brackets,插件还是很方便的……)
写起来感觉越来越省事……(或许是吐着吐着习惯了……)


**自己简化 MarkDown 的语法**

MarkDown 不好学就是因为要记一些规则,而且没啥提示。我记得有本书《深入浅出……》,提到人脑记忆的一点点小规律哈。就是要让脑子认为这个东西简单到和“老虎很危险,看见要逃跑”这么简单,脑子就能记住。

“#”代表标题(语文学渣谈协作……)
“-”和“n.” 代表无序和有序列表
“(url)”代表链接
“!(url)”代表图片

当然还有好多好多语法,往上能够找到,我就不在这里多说了。记住上面这些,一般的项目文档,我觉得就足够了哈。

**参考**
http://daringfireball.net/projects/markdown/
http://wowubuntu.com/markdown/
已邀请:

要回复问题请先登录注册