Markdown的说明文档

2016-08-22 本文已影响458人小小亭长

Markdown

导语：

Markdown是一种轻量级『标记语言』，它允许人们“使用易读易写的纯文本格式编写文档，然后转换成有效的XHTML(或者HTML)文档”。
创始人为约翰·格鲁伯（John Gruber），初始版本发布在2004年3月19日。

一、关于Markdown

文本格式一种规范，使用简洁的语法代替繁琐的排版，与HTML语言相比，特点是显而易见的，多种语法，字体样式、颜色等等设置都是相对简单得多的。相对简单的语法，使我们能更专心于书写自己的文档。所以越来越多的博客平台也都相继开始兼容markdown格式，例如github的README，就是最好的代表，国内的博客平台有：Oschina，简书，CSDN等等。

Markdown官相关文档

使用Markdown的优点

专注文本，而不是排版
多种格式可供导出（PDF、HTML等）
纯文本格式，多平台兼容
可读性强，可供多种人群读写

Markdown开发工具

Windows

Markdownpad

MAC

Mou

浏览器

二、Markdown语法

作用域

像很多的其他编程语言一样，每个方法或者类都有一个范围或权限修饰符。而markdown的语法范围几乎都是对称的（例如：*Hello World!*）,又开始必然有结束，当然也有一些特殊的类型只有开始符号（例如：#标题），在其结尾部分需要通过2个空格和换行来去其他部分区分

语法

标题

标题是每篇文章都需要也是最常用的格式，在 Markdown 中，如果一段文字被定义为标题，只要在这段文字前加 # 号即可。
# 一级标题

## 二级标题

### 三级标题

列表
列表有有序列表与无序列表的区别，在 Markdown 下，列表的显示只需要在文字前加上 - 或 * 即可变为无序列表，有序列表则直接在文字前加 1. 2. 3. 符号要和文字之间加上一个字符的空格。
引用
如果你需要引用一小段别处的句子，那么就要用引用的格式。
链接
链接文字的括号后面再接上另一个方括号，而在第二个方括号里面要填入用以辨识链接的标记,在解释标示的地方加上链接地址和说明；当然也可以直接用括号加上链接地址：

This is [an example][id] reference-style link.
[id]: http://example.com/ "Optional Title Here"

或者
This is [an example](http://example.com/) reference-style link.

图片
插入链接与插入图片的语法很像，区别在一个!号。可以先将图片上传到自己的云空间，生成可以访问的外链即可。

粗体与斜体
Markdown 的粗体和斜体也非常简单，用一个 * 包含一段文本就是斜体的语法,用两个 * 包含一段文本就是粗体的语法，用三个 * 包含一段文本就是斜体加粗体的语法。
例如：
这里是粗斜体
这里是粗体
这里是斜体加粗体
表格
表格是Markdown中最烦的语法，"|"表示表格范围，"-"表示内容范围，":"表示对齐方式（:---和---左对齐，---：右对齐，---：中间对齐）例子如下：

Tables	Are	Cool
col 3 is	right-aligned	$1600
col 2 is	centered	$12
zebra stripes	are neat	$1

源代码
| Tables| Are | Cool |
| ------------- |:-------------:| -----:|
| col 3 is | right-aligned | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat |$1 |

代码框
如果你是个程序猿，需要在文章里优雅的引用代码框，在 Markdown 下实现也非常简单，只需要用两个 "`" 把中间的代码包裹起来，如 code。也可使用 tab 键即可缩进。
分割线
分割线的语法只需要另起一行，连续输入三个星号 *** 即可。
脚注
用来表示一些注解
hello[^hello]

效果：
hello^[1]

总结

目前总计10种语法格式，再借助工具，学习成本比较低；在使用过程中很多公司也在使用Md来开发接口文档，这样会便于版本管理，这可能会是未来的一个趋势和潮流。

三、转义

在前面加上反斜杠来帮助插入普通的符号

.END.

hi ↩