是我参与「第三届青训营 -后端场」笔记创作活动的第2篇笔记
- 在第一次加入到青训营小组时，我感受到了这奋进和年轻的氛围，这也同时激发了我进一步学习进步的热情。
在大佬云集的小组中，我的技术栈显示的并不是那么的足够，所以在一开始大佬们设计实现方案的时候，我就得到了一份文档撰写的工作
这个任务很重，因为这个文档将会在我们的项目主页展示出来。
在这种背景下，我开始了我的文档的编写之路，不断的给自己提供写作之方。
- 文档，故名自已以文字来进行存档，但是我们不会只是利用一些word之类的来进行，我们用的最多的便是markdown语法。
在我们在github上冲浪的时候，基本上每个项目都会有一个readme.md文件，里面详细记录了各种的使用方式，配置流程等等。
我们就可以从这里看出来，文档存在的意义以及价值。以及如何去撰写这种项目文档。
-
记得我曾经问过自己，啥是.md格式，后来接触到markdown之后发现，这个真是一个极为方便快捷的写作工具，而在我们的学习过程中发现，很多的工具，包括网站都会有一个支持的markdown语法的编辑器，不论是typora，还是github，还有我们掘金社区提供的非常好用的编辑器。都极的提高了我们写文档的效率。
-
既然离不开markdown语法，我们倒不如，真正的去系统的学习以下，下面是我总结的一些语法，以及相关的应用，有哪里不对，还望大家批评指正。
Markdown 学习
标题 ：
这是的一级标题
二级标题
三级标题
四级标题
五级标题
六级标题
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
段落
** 这里是第一段 （双空格|或者回车）**
字体
*斜体文本*
_斜体文本_
**粗体文本**
__粗体文本__
***粗斜体文本***
___粗斜体文本___
斜体文字
斜体文字
粗体文字
粗体文字
粗斜体文字
粗斜体文字
列表
无序列表
* 第一项
* 第二项
* 第三项
+ 第一项
+ 第二项
+ 第三项
- 第一项
- 第二项
- 第三项
- （*）第一项
- （+）第二项
- （-）第三项
有序列表
1. 第一项
2. 第二项
3. 第三项
- 第一项
- 第二项
- 第三项
列表嵌套
1. 第一项：
- 第一项嵌套的第一个元素
- 第一项嵌套的第二个元素
2. 第二项：
- 第二项嵌套的第一个元素
- 第二项嵌套的第二个元素
1.第一项
- 第一个嵌套
- 第二个嵌套
2.第二项
- 第一个嵌套
区块
> 区块引用
> 菜鸟教程
> 学的不仅是技术更是梦想
区块引用
语法学习
不积跬步无以至千里
区块嵌套
> 最外层
> > 第一层嵌套
> > > 第二层嵌套
最外层
第一层嵌套
第二层嵌套
区块中使用列表
> 区块中使用列表
> 1. 第一项
> 2. 第二项
> + 第一项
> + 第二项
> + 第三项
这是一个区块
这是一个有序列表
这也是一个有序列表
- 这是一个无序列表
- 这也是一个无序列表
列表中使用区块
* 第一项
> 菜鸟教程
> 学的不仅是技术更是梦想
* 第二项
-
这时一个无序列表
语法学习
不积跬步无以至千里
-
这也是一个无序列表
代码块
方式1
```javascript
$(document).ready(function () {
alert('RUNOOB');
});
```
方式2
代码区块
代码区块使用 4 个空格或者一个制表符（Tab 键）。
链接
[链接名称](链接地址)
或者
<链接地址>
高级链接
这个链接用 1 作为网址变量 [Google][1]
这个链接用 runoob 作为网址变量 [Runoob][runoob]
然后在文档的结尾为变量赋值（网址）
[1]: http://www.google.com/
[runoob]: http://www.runoob.com/
[百度][www.baidu.com]
[google][ www.google.com]
图片
- 开头一个感叹号 !
- 接着一个方括号，里面放上图片的替代文字
- 接着一个普通括号，里面放上图片的网址，最后还可以用引号包住并加上选择性的 'title' 属性的文字。
```markdown
这个链接用 1 作为网址变量 [RUNOOB][1].
然后在文档的结尾为变量赋值（网址）
[1]: http://static.runoob.com/images/runoob-logo.png
<img src="http://static.runoob.com/images/runoob-logo.png" width="50%">
表格
Markdown 制作表格使用 | 来分隔不同的单元格，使用 - 来分隔表头和其他行。
语法格式如下：
| 表头 | 表头 |
| ---- | ---- |
| 单元格 | 单元格 |
| 单元格 | 单元格 |
| 表头 | 表头 |
|---|---|
| 单元格 | 单元格 |
| 单元格 | 单元格 |
| 单元格 | 单元格 |
| 单元格 | 单元格 |
对齐方式
我们可以设置表格的对齐方式：
- -: 设置内容和标题栏居右对齐。
- :- 设置内容和标题栏居左对齐。
- :-: 设置内容和标题栏居中对齐。
Markdown 高级技巧
支持的 HTML 元素
使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重启电脑
使用 Ctrl+Alt+Del 重启电脑
转义
**文本加粗**
\*\* 正常显示星号 \*\*
**文本加粗**
Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号：
\ 反斜线
` 反引号
* 星号
_ 下划线
{} 花括号
[] 方括号
() 小括号
# 井字号
+ 加号
- 减号
. 英文句点
! 感叹号
公式
Markdown Preview Enhanced 使用 KaTeX 或者 MathJax 来渲染数学表达式。
KaTeX 拥有比 MathJax 更快的性能，但是它却少了很多 MathJax 拥有的特性。你可以查看 KaTeX supported functions/symbols 来了解 KaTeX 支持那些符号和函数。
默认下的分隔符：
-
$...$或者\(...\)中的数学表达式将会在行内显示。 -
$$...$$或者\[...\]或者 ````math` 中的数学表达式将会在块内显示。 -
$$ \begin{Bmatrix} a & b \\ c & d \end{Bmatrix} $$ $$ \begin{CD} A @>a>> B \\ @VbVV @AAcA \\ C @= D \end{CD} $$
typora 画流程图、时序图(顺序图)、甘特图
1、横向流程图源码格式：
graph LR
A[方形] -->B(圆角)
B --> C{条件a}
C -->|a=1| D[结果1]
C -->|a=2| E[结果2]
F[横向流程图]
2、竖向流程图源码格式：
graph TD
A[方形] --> B(圆角)
B --> C{条件a}
C --> |a=1| D[结果1]
C --> |a=2| E[结果2]
F[竖向流程图]
3、标准流程图源码格式：
st=>start: 开始框
op=>operation: 处理框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 结束框
st->op->cond
cond(yes)->io->e
cond(no)->sub1(right)->op
4、标准流程图源码格式（横向）：
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
5、UML时序图源码样例：
对象A->对象B: 对象B你好吗?（请求）
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->对象A: 我很好(响应)
对象A->对象B: 你真的好吗？
6、UML时序图源码复杂样例：
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: 没人陪我玩
7、UML标准时序图样例：
%% 时序图例子,-> 直线，-->虚线，->>实线箭头
sequenceDiagram
participant 张三
participant 李四
张三->王五: 王五你好吗？
loop 健康检查
王五->王五: 与疾病战斗
end
Note right of 王五: 合理 食物 <br/>看医生...
李四-->>张三: 很好!
王五->李四: 你怎么样?
李四-->王五: 很好!
8、甘特图样例： 这里 由于一些原因，在笔记时无法正确显示，在typora里可以正常显示，这里直接显示源码，有需要之时可以作为基础进行修改
```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
