之前没写过接口文档，来到新公司后由于后台的兄弟们工作量较大，抽不出时间来编写接口文档，因此这个任务就给我了。百度了下写接口文档比较好的几个软件，最终选择了markdown，在mac环境下可以下载一个macdown的APP来编写，本文主要记录markdown的使用和总结
标题
在 Markdown 中，你只需要在文本前面加上 # 即可实现标题格式，同理、你还可以增加二级标题、三级标题、四级标题、五级标题和六级标题，总共六级，只需要增加 # 即可，标题字号相应降低。例如：
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
注：一般在#和标题之间保留一个字符的空格，只是最标注的markdown写法
列表
列表格式也很常用，在 Markdown 中，你只需要在文字前面加上 - 就可以了，例如：
- 文本1
- 文本2
- 文本3
当然，也可以在文字前面直接加上1. 2. 3.就可以了，例如：
1. 文本1
2. 文本2
3. 文本3
注：-、1.和文本之间要保留一个字符的空格
链接和图片
在 Markdown 中，插入链接不需要其他按钮，你只需要使用[显示文本](链接地址)这样的语法即可，例如:
[百度](http://www.baidu.com)
在 Markdown 中，插入图片不需要其他按钮，你只需要使用这样的语法即可，例如:
引用
在我们写作的时候经常需要引用他人的文字，这个时候引用这个格式就很有必要了，在 Markdown 中，你只需要在你希望引用的文字前面加上 > 就好了，例如：
> 本文主要用于记录自己使用markdown过程的笔记和总结，供后续温故和需要的朋友参考，第一次写简书，不足之处望多指正！谢谢~
注：> 和文本之间要保留一个字符的空格
显示如下：
本文主要用于记录自己使用markdown过程的笔记和总结，供后续温故和需要的朋友参考，第一次写简书，不足之处望多指正！谢谢~
粗体和斜体
Markdown 的粗体和斜体也非常简单，用两个*包含一段文本就是粗体的语法，用一个 *包含一段文本就是斜体的语法。例如：
**粗体**,*斜体*
显示如下：
粗体,斜体
代码引用
需要引用代码时，分为两种情况：
- 不分行:可以用 ` 将语句包起来
- 分多行:将3个`置于这段代码的首行和末行
注：分多行时，若发现不换行，注意是否回车换行
表格
相关代码：
1.行名居左，数据居右
| 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 |
2.行名居中，数据居中
| 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作为一款优秀的写作软件，兼容性极强，且支持文本编辑器，可以导出HTML、PDF格式等，具有极好的可读性，建议不断深入学习，并用它写出更多有用的文章、记录更多的技术文档，加油！
