简介

Markdown是一种轻量级的标记语言，由John Gruber于2004年创建。它的设计目标是让人们能够使用易读易写的纯文本格式编写文档，并且可以通过工具将其转换为结构化的HTML（超文本标记语言）文档或其他格式。

中文网

https://www.markdown.cn/

https://markdown.com.cn/

特点

简洁性：Markdown的语法非常简单，它仅包含少量的符号来表示文本格式，如标题、列表、链接、图片等。这使得写作者可以专注于内容本身而非排版细节。

可读性：即使不经过任何渲染，Markdown文本也易于阅读，因为它尽量保持了纯文本的原貌，避免了复杂的标签和格式化指令。

多功能性：Markdown 文件通常以.md或.markdown扩展名保存，并且可以在几乎所有的文本编辑器中打开。此外，许多平台和应用程序都支持Markdown格式，比如GitHub、GitLab、Stack Overflow等网站，以及一些博客系统和Wiki平台。

跨平台兼容性：由于Markdown文件本质上是纯文本文件，因此它们与操作系统无关，可以在不同的设备和平台上轻松共享和协作。

易于版本控制：Markdown文件适合纳入版本控制系统，如Git，因为它们是纯文本格式，便于追踪更改历史。

扩展性：虽然标准的Markdown语法相对固定，但很多Markdown编辑器和处理器提供了额外的功能，例如表格、脚注、定义列表、任务列表、数学公式、Mermaid图表等高级特性。

输出多样性：通过适当的工具，Markdown文档可以被转换成多种格式，包括但不限于 HTML、PDF 和 Word 文档。

语法

标题

使用#来表示标题级别，从一级到六级标题分别对应一个到六个#。

# 一级标题

## 二级标题

### 三级标题

#### 四级标题

##### 五级标题

###### 六级标题

效果

自定义ID标题

Markdown处理器支持标题的自定义ID，要添加自定义标题ID，请在与标题相同的行上用大括号括起该自定义ID。 可以通过url后接#ID方法跳转至页面锚点处。

### 自定义标题测试 {#test}

效果

强调

用星号*或下划线_来包裹文字来表示斜体或粗体。

• 斜体：*斜体文字* 或 _斜体文字_

• 粗体：**粗体文字** 或 __粗体文字__

• 粗斜体：***粗斜体文字*** 或 ___粗斜体文字___

效果

段落

使用空白行将一行或多行文本进行分隔

段落一

段落二

效果

段落一

段落二

换行

在一行的末尾添加两个或多个空格，然后按回车键,即可创建一个换行

这是直接换行的

效果

效果

这是直接换行的

效果

列表

• 无序列表使用星号*、加号+或减号-；

• 有序列表则使用数字加英文句点.(数字不必按数学顺序排列，但是列表应当以数字1起始)

* 项目1

* 项目2

- 子项目1

- 子项目2

+ 项目一

+ 项目二

1. 第一项

1. 第二项

3. 第三项

效果

• 项目1

• 项目2

• 子项目1

• 子项目2

• 项目一

• 项目二

1. 第一项

2. 第二项

3. 第三项

列表中可以嵌套其他元素：段落、引用、代码块、图片等

引用

要创建块引用，请在段落前添加一个>符号。

> 这是一个引用示例

效果

这是一个引用示例

代码

• 单行代码标注使用`

• 多行代码块标注使用 ```，可添加对应语言，实现代码高亮

`test`

```java

System.out.println("代码块");

```

效果

短语

System.out.println("代码块");

如果代码标注中需要包含一个或多个反引号，可以在外层使用是多添加一个反引号，内容前后加空格；

短语使用两个反引号；代码块使用四个反引号。

链接

• 链接文本放在中括号内，链接地址放在后面的括号中，链接title可选。

• 链接也可和强调联合使用

效果

图片

图片和链接格式相似，多了一个!前缀

效果

这是一个图片

分隔线

可以通过三种方式创建分割线：单行连续三个或更多的 *,-, 或者_。

***

---

_________________

效果

删除线

在要删除内容前后使用两个波浪号~~

这是要~~删除的内容~~

效果

这是要删除的内容

表格

• 使用三个或多个连字符（---）创建每列的标题，并使用管道（|）分隔每列；

• 可以在标题行中的连字符的左侧，右侧或两侧添加冒号（:），将列中的文本对齐到左侧，右侧或中心；

• 可以联合单行代码、链接使用。

| 第一列 | 第二列     | 第三列  |

| :---  |    :----:  |   ---: |

| 居左1   | 居中1       | 居右1   |

| 这是`代码`   | 这是`代码`       | [这是链接]()   |

效果

第一列

第二列

第三列

居左1

居中1

居右1

这是代码

这是代码

这是链接

任务列表

• 创建任务列表，请在任务列表项之前添加破折号-和方括号[ ]，并在[ ]前面加上空格。

• 要选择一个复选框，请在方括号[x]之间添加 x。

- [ ] 未选中任务

- [x] 选中任务

效果

定义列表

创建定义列表，请在第一行上键入术语。在下一行，键入一个冒号:，后跟一个空格和定义。

术语名称

: 这是术语的详细解释

效果

表情

• 从相关Emoji表情网站复制粘贴即可

• 也可以使用表情符号简码:https://gist.github.com/rxaviers/7360908

:smirk:

效果

转义字符

• 显示原本用于格式化Markdown文档的字符，在字符前面添加反斜杠字符\

• 可以转义的字符：\，`，*，_，{ }，[ ]，( )，#，+，-，.，!，|

\* 转义

效果

* 转义

内嵌HTML

HTML相关标签也可正常使用：<span>、<cite>、<del>、<a>、<img>、<div>、<table>、<pre>、<p>

数学公式

• 支持LaTeX数学表达式，需要渲染引擎如MathJax支持

• 行内公式：使用$包围公式。

• 独立公式：使用$$包围公式，使公式单独占据一行。

这是一个行内公式 $E=mc^2$。

$$ E=mc^2 $$

效果

这是一个行内公式 。

Mermaid绘图

• Mermaid是一种允许用户以文本方式定义图表的工具，

• 各图表具体使用方法见官方文档：https://mermaid.nodejs.cn

```Mermaid

graph TD;

A-->B;

A-->C;

B-->D;

C-->D;

```

流程图效果

高亮

高亮单词，在单词前后使用两个等号 ==

这是一个==高亮示例==。

效果

下标

创建下标，在字符前后使用一个波浪号 ~

H~2~O

效果

注意：==一些 Markdown 应用程序在单词前后使用一个波浪号，不是用于下标，而是用于删除线==。

上标

创建上标，请在字符前后使用一个插入符号 ^。

X^2^

效果

脚注

• 在方括号（[^1]）内添加插入符号和标识符。标识符可以是数字或单词，但不能包含空格或制表符。

• 标识符仅将脚注参考与脚注本身相关联-在输出中，脚注按顺序编号。

• 在括号内使用另一个插入符号和数字添加脚注，并用冒号和文本[^1]: My footnote。

效果

原文来源：https://mp.weixin.qq.com/s/hVBGgq_BesVbn1D1X9zmJg