作为一个程序员,肯定少不了写文档,而简洁易懂的文档则给自己和他人的工作带来了方便,用Markdown书写不是特别重要的说明文档则可以实现这一点。目前很多的开源库用的说明文档都是用Markdown写的
一,Markdown是什么
Markdown是一种轻量级标记语言,创始人为约翰·格鲁伯(John Gruber)。它与允许人们“使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档”。
说的通俗一点就是,Markdown用简洁的语法代替排版,而不像一般我们用的字处理软件Word或Pages 有大量的排版、字体设置,它是个非常简单,很容易学习的排版语法。
二,Markdown使用的工具
Mac平台:
推荐使用MacDown,下载地址:http://macdown.uranusjr.com
windows平台
MarkPad,下载地址:http://code52.org/DownmarkerWPF/
三,Markdown的常用排版样式
- 标题
在Markdown中标题的样式只需要在对应的标题文字前面加“#”,一个“#”对应的是一级标题,二个是二级标题,一直到六级标题。
如:### 这是个三级标题
或者在标题的下一行添加“=========”(一级标题),“-----------”(二级标题)
- 引用
在需要引用的文字前面加“>”,如:
这是段引用
- 强调
Markdown 使用星号和底线来标记需要强调的区段。
如:这会是斜体 , 这也会是斜体 , 这会被加粗,这也会被加粗
- 列表
无序列表使用星号、加号和减号来做为列表的项目标记
如:
Tom(* tom)
Kiny(* Kiny)
jeny(* jeny)
- 链接
使用中括号来把文字转成链接,中括号后面接小括号,里面放链接地址
如:This is an example link
6,图片
图片和链接很像,只是需要在中括号前面加一个!,如果是本地的图片,则需要将链接换成图片的路径
如:![图片](http://example.com/temp.png)
7,代码
使用一对“```”就可以搞定,如:
#pragma -mark viewLife
- (void)viewDidLoad {
[super viewDidLoad];
}
8,分割线
使用三个“*”或“-”,“_”等会生成一条虚线,使用一个“-”会生成一条实线
四,总结
Markdown的语法还有很多,以上介绍的一个都是最常用的,真正使用过程中会发现它的简洁和强大