背景介绍
一名开发工程师处理要写代码，还需要为代码注释，方便自己和他人理解代码；同时最重要的就是编写技术和开发文档，介绍技术和功能如何使用和对接；比如README.md文档，功能说明文档，接口文档，对接文档，开发文档等；
其中开发文档和API文档又是最重要等两个文档；文档编写规范和工具有很多，最简单等就是记事本和word；但是对开发文档和对接文档，开发人员最常用最好用的是通过markdown进行编写和阅读，目前慢慢成为开发文档的主要编写方式；
Markdown简介
Markdown 是一种轻量级标记语言，它允许人们使用易读易写的纯文本格式编写文档。
Markdown 语言在 2004 由约翰·格鲁伯（英语：John Gruber）创建。
Markdown 编写的文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档。
Markdown 编写的文档后缀为 .md, .markdown
Markdown 能被使用来撰写电子书，如：Gitbook。
当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。例如：GitHub、简书、reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge等。
markdown基本语法
标题
使用 # 号标记
使用 # 号可表示 1-6 级标题，一级标题对应一个 # 号，二级标题对应两个 # 号，以此类推。
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
段落
Markdown 段落没有特殊的格式，直接编写文字就好，段落的换行是使用两个以上空格加上回车。
文字格式
斜体文本
斜体文本
粗体文本
粗体文本
粗斜体文本
粗斜体文本删除线
分割线
*
—————
带下划线文本
[^要注明的文本]
列表
无需列表
第一项
第二项
* 第三项
- 第一项
+ 第二项
+ 第三项
- 第一项
- 第二项
- 第三项
有序列表
1. 第一项
2. 第二项
3. 第三项
列表嵌套
列表嵌套只需在子列表中的选项前面添加四个空格即可：
1. 第一项：
- 第一项嵌套的第一个元素
- 第一项嵌套的第二个元素
2. 第二项：
- 第二项嵌套的第一个元素
- 第二项嵌套的第二个元素
Markdown 区块
Markdown 区块引用是在段落开头使用 > 符号 ，然后后面紧跟一个空格符号：
> 区块引用
> 菜鸟教程
> 学的不仅是技术更是梦想
区块中使用列表
区块中使用列表实例如下：
> 区块中使用列表
> 1. 第一项
> 2. 第二项
> + 第一项
> + 第二项
> + 第三项
列表中使用区块
如果要在列表项目内放进区块，那么就需要在 > 前添加四个空格的缩进。
区块中使用列表实例如下：
第一项
> 菜鸟教程
> 学的不仅是技术更是梦想
第二项
Markdown 代码
如果是段落上的一个函数或片段的代码可以用反引号把它包起来（`），例如：printf() 函数
代码区块
代码区块使用 4 个空格或者一个制表符（Tab 键）。
你也可以用 ``` 包裹一段代码，并指定一种语言（也可以不指定）：javascript<br />$(document).ready(function () {<br /> alert('RUNOOB');<br />});<br />
Markdown 链接
链接使用方法如下：
链接名称
或者
<链接地址>
直接使用链接地址：
https://www.runoob.com
高级链接
我们可以通过变量来设置一个链接，变量赋值在文档末尾进行：
这个链接用 1 作为网址变量 [Google][1]
这个链接用 runoob 作为网址变量 [Runoob][runoob]
然后在文档的结尾为变量赋值（网址）
[1]: http://www.google.com/
[runoob]: http://www.runoob.com/
Markdown 图片
Markdown 图片语法格式如下：
- 开头一个感叹号 !
- 接着一个方括号，里面放上图片的替代文字
- 接着一个普通括号，里面放上图片的网址，最后还可以用引号包住并加上选择性的 ‘title’ 属性的文字。
使用实例：
Markdown 还没有办法指定图片的高度与宽度，如果你需要的话，你可以使用普通的 标签。
表格
Markdown 表格
Markdown 制作表格使用 | 来分隔不同的单元格，使用 - 来分隔表头和其他行。
语法格式如下：
| 表头 | 表头 |
| —— | —— |
| 单元格 | 单元格 |
| 单元格 | 单元格 |
|---|---|
对齐方式
我们可以设置表格的对齐方式：
- -: 设置内容和标题栏居右对齐。
- :- 设置内容和标题栏居左对齐。
- :-: 设置内容和标题栏居中对齐。
实例如下：
| 左对齐 | 右对齐 | 居中对齐 |
| :——-| ——: | :——: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |
|---|---|---|
Markdown 高级技巧
支持的 HTML 元素
不在 Markdown 涵盖范围之内的标签，都可以直接在文档里面用 HTML 撰写。
目前支持的 HTML 元素有：<kbd> <b> <i> <em> <sup> <sub> <br>等 ，如：
使用 Ctrl+Alt+Del 重启电脑
转义
Markdown 使用了很多特殊符号来表示特定的意义，如果需要显示特定的符号则需要使用转义字符，Markdown 使用反斜杠转义特殊字符：
文本加粗
** 正常显示星号 **
Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号：
\ 反斜线
` 反引号
* 星号
_ 下划线
{} 花括号
[] 方括号
() 小括号
# 井字号
+ 加号
- 减号
. 英文句点
! 感叹号
公式
当你需要在编辑器中插入数学公式时，可以使用两个美元符 包裹 TeX 或 LaTeX 格式的数学公式来实现。提交后，问答和文章页会根据需要加载 Mathjax 对数学公式进行渲染。如：
\mathbf{V}_1 \times \mathbf{V}_2 = \begin{vmatrix}
\mathbf{i} & \mathbf{j} & \mathbf{k} \
\frac{\partial X}{\partial u} & \frac{\partial Y}{\partial u} & 0 \
\frac{\partial X}{\partial v} & \frac{\partial Y}{\partial v} & 0 \
\end{vmatrix}
${$tep1}{\style{visibility:hidden}{(x+1)(x+1)}}
$$
以下几个实例效果图如下：
1、横向流程图源码格式：mermaid<br />graph LR<br />A[方形] -->B(圆角)<br /> B --> C{条件a}<br /> C -->|a=1| D[结果1]<br /> C -->|a=2| E[结果2]<br /> F[横向流程图]<br />
2、竖向流程图源码格式：mermaid<br />graph TD<br />A[方形] --> B(圆角)<br /> B --> C{条件a}<br /> C --> |a=1| D[结果1]<br /> C --> |a=2| E[结果2]<br /> F[竖向流程图]<br />
3、标准流程图源码格式：flow<br />st=>start: 开始框<br />op=>operation: 处理框<br />cond=>condition: 判断框(是或否?)<br />sub1=>subroutine: 子流程<br />io=>inputoutput: 输入输出框<br />e=>end: 结束框<br />st->op->cond<br />cond(yes)->io->e<br />cond(no)->sub1(right)->op<br />
4、标准流程图源码格式（横向）：flow<br />st=>start: 开始框<br />op=>operation: 处理框<br />cond=>condition: 判断框(是或否?)<br />sub1=>subroutine: 子流程<br />io=>inputoutput: 输入输出框<br />e=>end: 结束框<br />st(right)->op(right)->cond<br />cond(yes)->io(bottom)->e<br />cond(no)->sub1(right)->op<br />
5、UML时序图源码样例：sequence<br />对象A->对象B: 对象B你好吗?（请求）<br />Note right of 对象B: 对象B的描述<br />Note left of 对象A: 对象A的描述(提示)<br />对象B-->对象A: 我很好(响应)<br />对象A->对象B: 你真的好吗？<br />
6、UML时序图源码复杂样例：sequence<br />Title: 标题：复杂使用<br />对象A->对象B: 对象B你好吗?（请求）<br />Note right of 对象B: 对象B的描述<br />Note left of 对象A: 对象A的描述(提示)<br />对象B-->对象A: 我很好(响应)<br />对象B->小三: 你好吗<br />小三-->>对象A: 对象B找我了<br />对象A->对象B: 你真的好吗？<br />Note over 小三,对象B: 我们是朋友<br />participant C<br />Note right of C: 没人陪我玩<br />
7、UML标准时序图样例：mermaid<br />%% 时序图例子,-> 直线，-->虚线，->>实线箭头<br /> sequenceDiagram<br /> participant 张三<br /> participant 李四<br /> 张三->王五: 王五你好吗？<br /> loop 健康检查<br /> 王五->王五: 与疾病战斗<br /> end<br /> Note right of 王五: 合理 食物 <br/>看医生...<br /> 李四-->>张三: 很好!<br /> 王五->李四: 你怎么样?<br /> 李四-->王五: 很好!<br />
8、甘特图样例：
```mermaid
%% 语法示例
gantt
dateFormat YYYY-MM-DD
title 软件开发甘特图
section 设计
需求 :done, des1, 2014-01-06,2014-01-08
原型 :active, des2, 2014-01-09, 3d
UI设计 : des3, after des2, 5d
未来任务 : des4, after des3, 5d
section 开发
学习准备理解需求 :crit, done, 2014-01-06,24h
设计框架 :crit, done, after des2, 2d
开发 :crit, active, 3d
未来任务 :crit, 5d
耍 :2d
section 测试
功能测试 :active, a1, after des3, 3d
压力测试 :after a1 , 20h
测试报告 : 48h
若有收获，就点个赞吧
0 人点赞
