[![npm package][npm-package]][npm-package-url] [![dependencies][dependencies]][dependencies-url] [![devDependencies][devDependencies]][devDependencies-url]
[![downloads-total][downloads-total]][downloads-total-url] [![downloads-month][downloads-month]][downloads-month-url]
[![stars][stars]][stars-url] [![forks][forks]][forks-url] [![issues][issues]][issues-url]
[![commitizen][commitizen]][commitizen-url] [![PRs][PRs]][PRs-url] [![license][license]][license-url]
Markdown 是一种轻量级标记语言，它允许人们使用易读易写的纯文本格式编写文档。
当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。例如：GitHub、简书、知乎等
推荐使用Typora，官网：https://typora.io/
设置之后会根据分级标题来自动生成目录。
语法：
[TOC]
注：github暂未支持。
[TOC]
在github生成TOC的方法：https://github.com/ekalinin/github-markdown-toc
windows系统需要基于golang实现的工具：https://github.com/ekalinin/github-markdown-toc.go
如果你有GO语言的编译环境，可以尝试自己编译，如果没有，可以直接下载编译好的二进制文件。
如windows系统64位 下载：gh-md-toc.windows.amd64.tgz （386 是32位，amd64是64位）
下载解压后，发现没有后缀名无法识别，实际上这是个exe文件，所以只需要暴力地在后面加上.exe就可以开始愉快使用了。
使用方法：
- 首先将.md文档复制到gh-md-toc.exe的根目录下
- 在该目录下打开系统命令行，输入命令：gh-md-toc.exe README.MD 生成目录
- 把生成的目录复制到.md文件即可。
这是gh-md-toc生成的目录：
语法：
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
Markdown 段落没有特殊的格式，直接编写文字，需要段落缩进时使用2个Tab
语法：
*斜体文本*
或 _斜体文本_
**粗体文本**
或 __粗体文本__
***粗斜体文本***
或 ___粗斜体文本___
斜体文本
斜体文本
粗体文本
粗体文本
粗斜体文本
粗斜体文本
如果段落上的文字要添加删除线，只需要在文字的两端加上两个波浪线 ~~ 即可，实例如下：
语法：
~~BAIDU.COM~~
BAIDU.COM
下划线可以通过 HTML 的 标签来实现：
语法：
<u>带下划线的文本</u>
注：github暂未支持。
带下划线的文本
文字高亮功能能使行内部分文字高亮，使用一对反引号。
语法：
`html` `css` `javascript`
html css javascript
你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线，行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线：
语法：
***
*****
- - -
----------
脚注是对文本的补充说明。
语法：
[^变量]
在文档结尾或其他位置給变量赋值：
[^变量]: 注明框内显示的内容
鼠标移到这里> [^哈喽]
[^哈喽]: 注明框内显示的内容
注：github暂未支持。
鼠标移到这里> 1
使用星号()、加号(+)或是减号(-*)作为列表标记：
语法：
* 第一项
* 第二项
+ 第一项
+ 第二项
- 第一项
- 第二项
- 第一项
- 第二项
使用数字并加上 . 号来表示
语法：
1. 第一项
2. 第二项
- 第一项
- 第二项
语法：
* [x] 第一项
* [ ] 第二项
* [ ] 第三项
-
第一项
-
第二项
-
第三项
语法：
1. 第一项：
- 第一项嵌套的第一个元素
- 第一项嵌套的第二个元素
2. 第二项：
- 第二项嵌套的第一个元素
- 第二项嵌套的第一个元素
- 第一项
- 嵌套1
- 嵌套2
- 第二项
- 嵌套1
- 嵌套2
- 嵌套1
区块引用是在段落开头使用 > 符号 ，然后后面紧跟一个空格符号：
语法：
> 区块引用
区块引用
回车键自动延伸区块
语法：
> 第一层
> > 第二层
> > > 第三层
第一层
第二层
第三层
语法：
> 区块中使用列表
> 1. 第一项
> 2. 第二项
> * 111
> * 222
区块中使用列表
- 第一项
- 第二项
- 111
- 222
语法：
* 第一项
> 区块
* 第二项
-
第一项
区块
区块
-
第二项
如果是段落上的一个函数或片段的代码可以用反引号把它包起来（`）：
语法：
`function()` 函数
function()函数
用 ``` 包裹一段代码，并指定一种语言（也可以不指定）：
本代码区块为说明：
语法：
```javascript
function test() {
alert('test')
}
```
效果：
function test() {
alert('test')
}语法：
[链接名称](链接地址)
[链接名称](链接地址,可选的alt)
或
<链接地址>
例如：
语法：
[百度](http://www.baidu.com,'百度')
直接显示链接地址：
语法：
<http://www.baidu.com>
http://www.baidu.com
语法：
链接可以用变量来代替，文档末尾或其他位置附带变量地址：
这个链接用 1 作为网址变量 [Google][1]
这个链接用 baidu 作为网址变量 [Baidu][baidu]
然后在文档的结尾为变量赋值（网址）
[1]: http://www.google.com/
[baidu]: http://www.baidu.com/
语法：
可使用相对路径（前提是有该路径下的文件）
[test](test.md)
本文件中每一个标题都是一个锚点，和HTML的锚点（#）类似
语法：
[Mackdown](#Mackdown)
注： github对含有标点符号的标题进行锚点时会忽略掉标点符号， 本页中，如果这样写则无法跳转：[链接](#八、链接) 正确写法：[链接](#八链接)
语法：
-
开头一个感叹号 !
-
接着一个方括号，里面放上图片的替代文字
-
接着一个普通括号，里面放上图片的地址，最后还可以用引号包住并加上选择性的 'title' 属性的文字。
语法：
当然，你也可以像链接那样对图片地址使用变量:
这里链接用 img 作为图片地址变量
然后在文档的结尾或其他位置给变量赋值（图片地址）
语法：
![RUNOOB][img]
[img]: ./test/logo.png
如下想设置图片宽高，可以使用 标签。
语法：
<img src="./test/logo.png" width="50px" height="30px">
不管是在本地还是在github同一个仓库中，如果图片存在，可以使用相对路径。github上如果引用其他github仓库中的图片则要注意地址格式，即：仓库地址/raw/分支名/图片路径
相对路径图片：
语法：
其他仓库的图片：
语法：
制作表格使用 (|) 来分隔不同的单元格，使用( -) 来分隔表头和其他行。
语法：
| 表头 | 表头 |
| ---- | ---- |
| 单元格 | 单元格 |
| 单元格 | 单元格 |
| 表头 | 表头 |
|---|---|
| 单元格 | 单元格 |
| 单元格 | 单元格 |
对齐方式
- -: 设置内容和标题栏居右对齐
- :- 设置内容和标题栏居左对齐
- :-: 设置内容和标题栏居中对齐
语法：
| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |
| 左对齐 | 右对齐 | 居中对齐 |
|---|---|---|
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |
语法： Emoji表情英文名的前后加冒号，Typore上先输入冒号再输入首字母有表情提示
如：
:smirk:
😏😊😃😄 ☀️
😸🙈🐴
💋
更多表情名称请查看：表情包备忘单
不在 Markdown 语法涵盖范围之内的标签，都可以直接在文档里面用 HTML 撰写。
目前支持的 HTML 元素有：<kbd> <b> <i> <em> <sup> <sub> <br>等 ，如：
语法：
使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重启电脑
使用 Ctrl+Alt+Del 重启电脑
使用b标签的加粗字体
Markdown 使用了很多特殊符号来表示特定的意义，如果需要显示特定的符号则需要使用反斜杠转义字符：
语法：
**未转义星号显示加粗**
\*\* 转义显示星号 \*\*
未转义星号显示加粗 ** 转义显示星号 **
Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号：
\ 反斜线
` 反引号
* 星号
_ 下划线
{} 花括号
[] 方括号
() 小括号
# 井字号
+ 加号
- 减号
. 英文句点
! 感叹号
*** 以下部分在Github暂未支持 ***
当你需要在编辑器中插入数学公式时，可以使用两个美元符 $$ 包裹 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)}}
$$
语法：
```chart
,Budget,Income,Expenses,Debt
June,5000,8000,4000,6000
July,3000,1000,4000,3000
Aug,5000,7000,6000,3000
Sep,7000,2000,3000,1000
Oct,6000,5000,4000,2000
Nov,4000,3000,5000,
type: pie
title: Monthly Revenue
x.title: Amount
y.title: Month
y.suffix: $
```
```mermaid
sequenceDiagram
A->>B: 是否已收到消息？
B-->>A: 已收到消息
```
注：在Typora中未支持
,Budget,Income,Expenses,Debt
June,5000,8000,4000,6000
July,3000,1000,4000,3000
Aug,5000,7000,6000,3000
Sep,7000,2000,3000,1000
Oct,6000,5000,4000,2000
Nov,4000,3000,5000,
type: pie
title: Monthly Revenue
x.title: Amount
y.title: Month
y.suffix: $
语法：
```mermaid
graph TD
A[模块A] -->|A1| B(模块B)
B --> C{判断条件C}
C -->|条件C1| D[模块D]
C -->|条件C2| E[模块E]
C -->|条件C3| F[模块F]
```
graph TD
A[模块A] -->|A1| B(模块B)
B --> C{判断条件C}
C -->|条件C1| D[模块D]
C -->|条件C2| E[模块E]
C -->|条件C3| F[模块F]
语法：
```mermaid
sequenceDiagram
A->>B: 是否已收到消息？
B-->>A: 已收到消息
```
sequenceDiagram
A->>B: 是否已收到消息？
B-->>A: 已收到消息
语法：
```mermaid
gantt
title 甘特图
dateFormat YYYY-MM-DD
section 项目A
任务1 :a1, 2018-06-06, 30d
任务2 :after a1 , 20d
section 项目B
任务3 :2018-06-12 , 12d
任务4 : 24d
```
gantt
title 甘特图
dateFormat YYYY-MM-DD
section 项目A
任务1 :a1, 2018-06-06, 30d
任务2 :after a1 , 20d
section 项目B
任务3 :2018-06-12 , 12d
任务4 : 24d
回到顶部
Footnotes
-
注明框内显示的内容 ↩