#Markdown的应用场景

什么是Markdown: https://zh.wikipedia.org/wiki/Markdown

Markdown可以用来干什么:

  1. 博客写作, Hexo
  2. 文档写作, GitHub README.md, API document
  3. 笔记记录, 结合印象笔记的马克飞象

博客写作

Hexo是一个使用NodeJS的静态文本生成器,比较Geek,Github提供了静态文件托管的功能,Git Page应运而生。我们可以将Hexo生成的静态文件托管到Github,搭建一个属于自己的博客,教程链接戳我

文档写作

Github对*.md有自己的解析样式,可以参考一下。Github将Markdown解析成对应的Html,然后用前面的样式进行渲染,我们也可以在此基础上面进行二次开发,例如增加对代码片段的不同语言的语法支持,Javascript, Java, CSS等等

我们团队开发API的时候也可以用到Markdown
先分目录,WEB-API, APP-API
再分别写API目录, web-api-summary.md, app-api-summary.md,这两个markdown文件里面全是对子markdown的链接,方便查找
最后再写API详情, F0010.md, F0020.md, F0030.md,每个文档之间留够10个空隙,以备日后新增API

这样项目开发人员可以通过GitHub在线共享开发文档,可以很直观的进行编辑。Markdown的语法对于程序员们来说应该是很亲切的了。

笔记记录

印象笔记唯一不爽的我觉得是对Markdown的支持,其他的简直完美无缺。有了马克飞象,对于程序员们来说真的就是飞了起来的感觉。

Markdown plugin & Markdown App

  1. 宇宙最好编辑器Sublime Text 的sublimetext-markdown-preview插件
  2. Mou