近来尝试使用markdown来写技术文档,写完之后将写好的markdown文件转成HTML,用该HTML文件作为最终的文档进行管理。这样做的好处是,可以有效的节省时间,就像markdown语言作为一门标记性语言的好处,用户可以更加纯粹的关注文档的内容,而不必花时间在排版工作上。
其实包括你现在看到的这篇博客,也是用markdown语言写的,用hexo
+github page
就可以快速搭建类似该博客的网站了。读者可以在网上搜一下教程,这里不做说明。(我没收宣传费…)
引用一句别人的话,这么纯粹的语言太适合我这么纯粹的人了(严肃脸)
seriously I mean.
Markdown的目标是实现「易读易写」。
1. Get start(亦即Markdown基本语法)
一开始当然是先要看markdown的基本语法,虽然比较简单:
1-1. 标题
标题使用#
号,#
的数目与标题的大小相关。
1 | # This is an <h1> tag |
效果图如下:
This is an <h1> tag
This is an <h2> tag
This is an <h3> tag
This is an <h4> tag
This is an <h5> tag
This is an <h6> tag
1-2. 区块引用
1 | > This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet, |
效果图如下:
This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
id sem consectetuer libero luctus adipiscing.
1-3. 列表
对于无序列表,在条目前加星号、加号减号都可以
1 | * The first li element |
- The first li element
- The second li element
- The third li element
而对于有序列表,则可以用以下的形式:
1 | 1. The first li element |
- The first li element
- The second li element
- The third li element
1-4. 代码参考
行内代码
行内代码可以用反引号包围起来,如:
1 | `inline code` |
会显示为inline code
1-5. 代码段
对于一整段的代码,则可以用三个连续的反引号来包围。
1 | try (code) { |
1-6. 分割线
一行中用三个以上的星号、减号、底线都可以建立一个分隔线,行内不能有其他内容。
也可以在星号或是减号中间插入空格。
下面的写法都可以建立分隔线:
1 | * * * |
1-7. 链接
链接的语法也很简单,链接可以插入到行里小狒sin的博客
1 | [小狒sin的博客](http://s1nker.github.io) |
1-8. 图片
其实图片的插入方法和图片有点像:看来你们不懂生命的可贵~
1 |  |
markdown语法的简单介绍就到这里啦~更详尽的资料请戳这里
2. Markdown编辑器推荐
原则上用任何的文本编辑软件都可以写Markdown,但是专用的编辑器一般是带有预览框的,可以随时看到自己写的Markdown文件编译成HTML后的样子,非常快捷方便。
MarkdownPad2
网上盛传的windows系统下最好的Markdown编辑器,但是对于我来说似乎不怎么好用……
因为不支持GFM等扩展语法,对于程序员来说不能插入代码就失去意义了~
SublimeText
对于钟爱SublimeText的前端程序猿,可以在SublimeText的Package Install中安装markdown编辑的扩展,可以快捷键在预览器上进行HTML预览。这里推荐markdown editing
插件。
Haroopad
这款工具是在非常偶然的机会下发现的,也是我现在正在使用的。
个人觉得比较特别的地方是Haroopad支持GFM等markdown语法扩展(点击顶部菜单的‘插入’):
可以看到有GFM(Github Flavored Markdown)、MultiMarkdown、PHP Extras Markdown和Haroopad Flavored Markdown,对于程序员来说,有了这些功能就可以更好的书写文档了。
Cmd Mrakdown
这是链接:Cmd Markdown编辑阅读器。
这是一款在线的Markdown编辑器,比较特别的地方在于它可以插入流程图、序列图等图表,对于要在文档中插入图表的情况会更加实用。
此外作为一款在线工具有云端保存等功能,也是非常方便。
But, 这个工具如果要到处带样式的HTML文件就要买会员咯,有点坑。
此外还推荐一个在线编辑器:简书,更像于内容分享社区,用得比较少,不做过多说明。
3. Markdown语法扩展
为了满足不同用户群体的需求,产生了不少markdown的语法扩展,比如上面说过了GFM(Github Flavored Markdown)、MultiMarkdown、PHP Extras Markdown等(“不同用户群体”都是程序猿吧?)。
在markdown基本语法的基础上增加了一些扩展性的语法,比如像是注释、带语言类型的代码段、删除线等等。
参考资料:
Markdown 语法说明 (简体中文版)
Mastering Markdown-Gihub Guides
本文如果有说得不正确的地方,欢迎发送邮件指出~