Markdown 注意事项以及使用说明

Markdown 是一种轻量级标记语言，它允许人们使用易读易写的纯文本格式编写文档,文档可以导出 HTML 、Word、图像、PDF、Epub 等多种格式的文档 , 文档后缀为 .md, .markdown。 编写工具: typora官网

1 编写规则以及效果:

我展示的是一级标题

我展示的是二级标题

我展示的是一级标题 我展示的是二级标题 使用 # 号可表示 1-6 级标题，一级标题对应一个 # 号，二级标题对应两个 # 号，以此类推。 2 编写规则以及效果:

一级标题

二级标题

三级标题

四级标题

五级标题

六级标题

1 2 3 4 5 6 一级标题 二级标题 三级标题 四级标题 五级标题 六级标题 3 编写规则以及效果: Markdown 段落没有特殊的格式，直接编写文字就好，段落的换行是使用两个以上空格加上回车。 当然也可以在段落后面使用一个空行来表示重新开始一个段落。

4 编写规则以及效果:

斜体文本斜体文本粗体文本粗体文本粗斜体文本粗斜体文本

斜体文本 斜体文本 粗体文本 粗体文本 粗斜体文本 粗斜体文本

下面为分割线 5 编写规则以及效果:

6 编写规则以及效果:

文字增加删除线 1 文字增加删除线 7 编写规则以及效果:

带下划线文本 1 带下划线文本

8 编写规则以及效果:

[^要注明的文本] 1 [^要注明的文本] 9 编写规则以及效果:

无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记：

• 第一项
• 第二项
• 第三项

• 第一项
• 第二项
• 第三项

• 第一项
• 第二项
• 第三项

无序列表使用星号(*)、加号(+)或是减号(-)作为列表标记：

第一项 第二项 第三项 第一项 第二项 第三项 第一项 第二项 第三项

10 编写规则以及效果: 有序列表使用数字并加上 . 号来表示，如：

1. 第一项
2. 第二项
3. 第三项

有序列表使用数字并加上 . 号来表示，如：

第一项 第二项 第三项 列表嵌套只需在子列表中的选项添加四个空格即可：

1. 第一项：
   • 第一项嵌套的第一个元素
   • 第一项嵌套的第二个元素
2. 第二项：
   • 第二项嵌套的第一个元素
   • 第二项嵌套的第二个元素

12 编写规则以及效果:

Markdown 区块引用是在段落开头使用 > 符号 ，然后后面紧跟一个空格符号：

区块引用 菜鸟教程 学的不仅是技术更是梦想

Markdown 区块引用是在段落开头使用 > 符号 ，然后后面紧跟一个空格符号：

区块引用 菜鸟教程 学的不仅是技术更是梦想

另外区块是可以嵌套的，一个 > 符号是最外层，两个 > 符号是第一层嵌套，以此类推：

最外层

第一层嵌套

第二层嵌套

最外层

第一层嵌套

第二层嵌套

区块中使用列表实例如下：

区块中使用列表

1. 第一项
2. 第二项

• 第一项
• 第二项
• 第三项

区块中使用列表

第一项 第二项 第一项 第二项 第三项 如果要在列表项目内放进区块，那么就需要在 > 前添加四个空格的缩进。

区块中使用列表实例如下：

• 第一项

  菜鸟教程 学的不仅是技术更是梦想

• 第二项

第一项 菜鸟教程 学的不仅是技术更是梦想

第二项 13 编写规则以及效果: 你也可以用 ```包裹一段代码，并指定一种语言（也可以不指定）：

$(document).ready(function () { alert('RUNOOB'); });

链接使用方法如下：

链接名称

或者

<链接地址>

链接名称

或者

http://www.baiducom

Markdown 图片语法格式如下： 1 2 使用实例：

14 编写规则以及效果:

Markdown 制作表格使用 | 来分隔不同的单元格，使用 - 来分隔表头和其他行。

语法格式如下：

表头 表头 单元格 单元格 单元格 单元格 15 编写规则以及效果:

1、横向流程图源码格式：

graph LR A[方形] -->B(圆角) B --> C{条件a} C -->|a=1| D[结果1] C -->|a=2| E[结果2] F[横向流程图]

a=1 a=2 方形 圆角 条件a 结果1 结果2 横向流程图 2、竖向流程图源码格式：

graph TD A[方形] --> B(圆角) B --> C{条件a} C --> |a=1| D[结果1] C --> |a=2| E[结果2] F[竖向流程图]

a=1 a=2 方形 圆角 条件a 结果1 结果2 竖向流程图 3、标准流程图源码格式：

flowchat st=>start: 开始框 op=>operation: 处理框 cond=>condition: 判断框(是或否?) sub1=>subroutine: 子流程 io=>inputoutput: 输入输出框 e=>end: 结束框 st->op->cond cond(yes)->io->e cond(no)->sub1(right)->op

开始框 处理框 判断框(是或否?) 输入输出框 结束框 子流程 yes no 4、标准流程图源码格式（横向）：

flowchat st=>start: 开始框 op=>operation: 处理框 cond=>condition: 判断框(是或否?) sub1=>subroutine: 子流程 io=>inputoutput: 输入输出框 e=>end: 结束框 st(right)->op(right)->cond cond(yes)->io(bottom)->e cond(no)->sub1(right)->op

开始框 处理框 判断框(是或否?) 输入输出框 结束框 子流程 yes no 5、UML时序图源码样例：

sequenceDiagram 对象A->>对象B: 对象B你好吗?（请求） Note right of 对象B: 对象B的描述 Note left of 对象A: 对象A的描述(提示) 对象B–>>对象A: 我很好(响应) 对象A->>对象B: 你真的好吗？

对象A 对象B 对象B你好吗?（请求） 对象B的描述 对象A的描述(提示) 我很好(响应) 你真的好吗？ 对象A 对象B 标题：复杂使用 6、UML时序图源码复杂样例：

sequenceDiagram Title: 标题：复杂使用 对象A->>对象B: 对象B你好吗?（请求） Note right of 对象B: 对象B的描述 Note left of 对象A: 对象A的描述(提示) 对象B–>>对象A: 我很好(响应) 对象B->>小三: 你好吗 小三–>>对象A: 对象B找我了 对象A->>对象B: 你真的好吗？ Note over 小三,对象B: 我们是朋友 participant C Note right of C: 没人陪我玩

对象A 对象B 小三 C 对象B你好吗?（请求） 对象B的描述 对象A的描述(提示) 我很好(响应) 你好吗 对象B找我了 你真的好吗？ 我们是朋友 没人陪我玩 对象A 对象B 小三 C 标题：复杂使用 7、UML标准时序图样例：

%% 时序图例子,-> 直线，–>虚线，->>实线箭头 sequenceDiagram participant 张三 participant 李四 张三->王五: 王五你好吗？ loop 健康检查 王五->王五: 与疾病战斗 end Note right of 王五: 合理 食物 看医生… 李四–>>张三: 很好! 王五->李四: 你怎么样? 李四–>王五: 很好!

张三 李四 王五 王五你好吗？ 与疾病战斗 loop [ 健康检查 ] 合理 食物 看医生... 很好! 你怎么样? 很好! 张三 李四 王五 标题：复杂使用 8、甘特图样例：

%% 语法示例 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

%% 语法示例 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

helloworld7