文档编写之Markdown

什么是markdown

Markdown是一种为简单而生的纯文本标记语言，以markdown格式编写的文档，最终通过相应的编辑器或者脚本转换成html用于页面渲染，其语法简单，便于写作，是程序员编写文档的不二之选。

分分钟掌握markdown基础语法

1. 标题

Markdown支持6种级别的标题，对应html标签 h1 ~ h6

# h1  一级标题
## h2 二级标题
### h3 三级标题
#### h4 四级标题
##### h5 五级标题
###### h6 六级标题

渲染后的显示效果:

h1 一级标题

h2 二级标题

h3 三级标题

h4 四级标题

h5 五级标题

h6 六级标题

2. 引用

Markdown提供了一个特殊符号>用于段首进行强调，被强调的文字部分将会高亮显示

> 这是一段引用文字

这是一段引用文字

3. 无序列表

Markdown的无序列表可以用 + 或 * 或 - 表示

* 地球
  * 中国
  * 美国
* 月球
* 太阳

+ 地球
  + 中国
  + 美国
+ 月球
+ 太阳

以上两种表达方式，最终都会转换成同一个html输出:

• 地球
  • 中国
  • 美国
• 月球
• 太阳

无序列表的二级列表前，需空两格

4. 有序列表

Markdown的有序列表用数字加点表示：

1. 中国
   1. 四川
   2. 上海
2. 俄罗斯
3. 美国

1. 中国
   1. 四川
   2. 上海
2. 俄罗斯
3. 美国

有序列表，Markdown将只关注你的第一个项目的数字编号。例如：如果第一个项目编号是3，以此类推，第二个项目应该是4，最终将显示为3、4、5。而如果你指定了第一个编号，后面的编号指定错误也没有关系，Markdown将只在乎你的第一个项目编号。

5. 插入超链接或图片

Markdown针对链接和图片的处理也比较简单，用中括号和括号表示，如下:

[点击跳转至Kaleoz.com](http://www.kaleoz.com)
![图片](https://upload-images.jianshu.io/upload_images/703764-605e3cc2ecb664f6.jpg?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240)

点击跳转至Kakeoz.com

引用图片和链接的唯一区别就是在最前方添加一个感叹号。链接地址和图片地址，可以是当前文档的相对路径，也可以是完整url地址，图片还可以直接用base64字符串。

6. 强调

Markdown表示强调的方式如下：

*这里是斜体*
_这里也是斜体_

**这里是加粗**
__这里也是加粗__

效果如下 :

这里是斜体 这里也是斜体

这里是加粗 这里也是加粗

7. 分隔线

Markdown加入分隔线非常简单，使用下面任意一种形式都可以，连接输入三个*或是三个 -

***
---

连续的3个*或-会被渲染成 <hr>

8. 表格

Markdown的表格也很简单，但是文字不好描述，先看一下示例：

表头|条目一(左对齐)|条目二
:---:|:---|:---:
项目|项目一|项目二
项目|项目一内容长一点|项目二

表头	条目一(左对齐)	条目二
项目	项目一	项目二
项目	项目一内容长一点	项目二

三个短斜杠左右的冒号用于控制对齐方式，只放置左边冒号表示文字居左，只放置右边冒号表示文字居右，如果两边都放置冒号表示文字居中。

9. 代码块

Markdown在IT圈子里面比较流行的一个重要原因是，它能够轻松漂亮地插入代码。代码块用3个反引号“`”包裹即可:

 echo "hello world";

单行代码可以用1个或2个反引号包裹，如果是多行代码，则用3个反引号包裹。