简介

Markdown 是一种轻量级标记语言，它允许人们使用易读易写的纯文本格式编写文档。

应用

当前许多网站都广泛使用 Markdown 来撰写帮助文档或是用于论坛上发表消息。例如：GitHub、简书、知乎等

编辑器

推荐使用Typora，官网：https://typora.io/

二、徽章

什么是徽章

徽章是一种小巧精美的小图标，一般配有相关文字进行辅助说明，可对数据进行监控，链接跳转等，富有表现力。

常见于github项目主页，但其不仅出现于 github 项目主页，凡是能够表现图片的地方都可以出现徽章。

徽章的使用

• 在markdown中使用

格式:
[![图片文字说明](图片源地址)](超链接地址)  # 即超链接内部嵌套图片
语法：
[![github](https://img.shields.io/badge/github-xugaoyi-brightgreen.svg)](https://github.com/xugaoyi)

徽章生成网站：https://shields.io/

本文档主要介绍markdown，不对徽章做过多介绍，详细介绍请 戳我 了解。

三、设置目录

设置之后会根据分级标题来自动生成目录。

[TOC]

注：github暂未支持。

在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就可以开始愉快使用了。

使用方法：

1. 首先将.md文档复制到gh-md-toc.exe的根目录下
2. 在该目录下打开系统命令行，输入命令：gh-md-toc.exe README.MD 生成目录
3. 把生成的目录复制到.md文件即可。

这是gh-md-toc生成的目录：

• 一、Markdown

• 简介
• 应用
• 编辑器

• 二、徽章

• 什么是徽章
• 徽章的使用

• 三、设置目录
• 四、标题

• 一级标题

• 二级标题

• 三级标题

• 四级标题

• 五级标题

• 六级标题

• 五、文本

• 段落
• 字体
• 删除线
• 下划线
• 文字高亮
• 分隔线
• 脚注

• 六、列表

• 无序列表
• 有序列表
• 折叠列表
• 带复选框列表
• 列表嵌套

• 七、区块引用

• 区块嵌套
• 区块中使用列表
• 列表中使用区块

• 八、代码

• 代码区块

• 九、链接

• 变量链接
• Github中使用内部链接
• 锚点链接

• 十、图片

• 图片宽高
• 相对路径以及Github中使用图片

• 十一、表格
• 十二、Emoji表情包
• 十三、其他技巧

• 支持的 HTML 元素
• 转义
• 数学公式
• 图表
• 流程图
• 时序图
• 甘特图

四、标题

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

一级标题

二级标题

三级标题

四级标题

五级标题

六级标题

五、文本

段落

Markdown 段落没有特殊的格式，直接编写文字，需要段落缩进时使用2个Tab

字体

*斜体文本* 
或 _斜体文本_
**粗体文本**
或  __粗体文本__
***粗斜体文本***
或 ___粗斜体文本___

斜体文本

斜体文本

粗体文本

粗体文本

粗斜体文本

粗斜体文本

删除线

如果段落上的文字要添加删除线，只需要在文字的两端加上两个波浪线 ~~ 即可，实例如下：

~~BAIDU.COM~~

BAIDU.COM

下划线

下划线可以通过 HTML 的<u> 标签来实现：

<u>带下划线的文本</u>

带下划线的文本

文字高亮

文字高亮能使行内部分文字高亮，使用一对反引号。

`html` `css` `javascript`

htmlcssjavascript

分隔线

你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线，行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线：

***
*****
- - -
----------

脚注

脚注是对文本的补充说明。

[^变量]
在文档结尾或其他位置給变量赋值：
[^变量]: 注明框内显示的内容
鼠标移到这里> [^哈喽]
[^哈喽]: 注明框内显示的内容

注：在部分线上预览未支持

鼠标移到这里> ^哈喽

六、列表

无序列表

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

* 第一项
* 第二项
+ 第一项
+ 第二项
- 第一项
- 第二项

• 第一项
• 第二项

有序列表

使用数字并加上 . 号来表示

1. 第一项
2. 第二项

1. 第一项
2. 第二项

折叠列表

<details>
<summary>点我打开关闭折叠</summary>
 折叠内容
 <ul>
     <li>1</li>
     <li>2</li>
     <li>3</li>
 </ul>
</details>

注意：<details> 标签内写markdown代码无效，可写html代码，如ul>li、table等

点我打开关闭折叠 折叠内容  

• 1
• 2
• 3

包含table的折叠    

带复选框列表

* [x] 第一项
* [ ] 第二项
* [ ] 第三项

注：在部分线上预览未支持

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

列表嵌套

1. 第一项：
    - 第一项嵌套的第一个元素
    - 第一项嵌套的第二个元素
2. 第二项：
    - 第二项嵌套的第一个元素
       - 第三层嵌套

1. 第一项

• 嵌套1
• 嵌套2

2. 第二项

- 嵌套1
  - 嵌套2

七、区块引用

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

> 区块引用

区块引用

Typora中回车键自动延伸区块

区块嵌套

> 第一层
> > 第二层
> > > 第三层

第一层

第二层

第三层

区块中使用列表

> 区块中使用列表
> 1. 第一项
> 2. 第二项
> * 111
> * 222

区块中使用列表

1. 第一项
2. 第二项

• 111
• 222

列表中使用区块

* 第一项
    > 区块
* 第二项

• 第一项

区块

区块

• 第二项
  

八、代码

如果是段落上的一个代码片段可以用反引号把它包起来（`），示例：

`alert()`

alert()

代码区块

用三个反引号 ``` 包裹一段代码，并指定一种语言（也可以不指定），指定代码语言后会有代码的颜色高亮

本代码区块为示例说明：

```javascript
function test() {
    alert('test')
}
```

效果：

function test() {
    alert('test')
}