在MkDocs中编写Markdown的技巧（自建中文手册）¶

约 785 个字 22 行代码 2 张图片预计阅读时间 3 分钟

查看次

参考¶

以下是一些在 MkDocs 中编写 Markdown 的技巧，参考自 MkDocs 官方文档及其子页面：

代码块¶

使用三个反引号来创建代码块：

Markdown
1 2 3	\```python print("Hello, World!") \```

表格¶

使用管道符号来创建表格：

Markdown
1 2 3	`\| 头1 \| 头2 \| \| --- \| --- \| \| 单元格1 \| 单元格2 \|`

脚注¶

使用 [^1] 来创建脚注：

Markdown
1 2 3	`这是一个脚注示例[^1]。 [^1]: 这是脚注内容。`

警告框¶

使用 !!! 来创建警告框：

Markdown
1 2	`!!! note 这是一个笔记。`

任务列表¶

使用 - [ ] 和 - [x] 来创建任务列表：

Markdown
1 2	`- [ ] 待办事项1 - [x] 已完成事项1`

数学公式¶

使用 $$ 来创建数学公式：

Markdown
1 2 3	`$$ E = mc^2 $$`

Mermaid 图表¶

使用 mermaid 关键字来创建 Mermaid 图表：

Markdown
1 2 3 4 5 6	```mermaid graph TD; A-->B; A-->C; B-->D; C-->D;

目录¶

使用 toc 关键字来创建目录：

Markdown
1	`[toc]`

引用¶

使用 > 来创建引用：

Markdown
1	`> 这是一个引用。`

链接¶

使用 [文本](链接) 来创建链接：

Markdown
1	`[MkDocs](https://www.mkdocs.org)`

图片¶

使用 ![alt 文本](图片链接) 来插入图片：

Markdown
1	`![MkDocs Logo](https://www.mkdocs.org/img/logo.png)`

粗体和斜体¶

使用 ** 或 __ 来创建粗体，使用 * 或 _ 来创建斜体：

Markdown
1 2	`这是粗体这是斜体`

删除线¶

使用 ~~ 来创建删除线：

Markdown
1	`~~这是删除线~~`

分隔线¶

使用 --- 来创建分隔线：

Markdown
1	`---`

内联代码¶

使用 ` 来创建内联代码：

Markdown
1	这是 `内联代码` 示例。

代码高亮¶

使用 highlight 关键字来高亮代码：

Markdown
1 2	```highlight print("Hello, World!")

代码折叠¶

使用 collapse 关键字来折叠代码：

Markdown
1 2	```collapse print("Hello, World!")

代码行号¶

使用 linenums 关键字来显示代码行号：

Markdown
1 2	```linenums print("Hello, World!")

代码标题¶

使用 title 关键字来添加代码标题：

Markdown
1 2	```title="example.py" print("Hello, World!")

代码副本按钮¶

使用 copy 关键字来添加代码副本按钮：

Markdown
1 2	```copy print("Hello, World!")

代码下载按钮¶

使用 download 关键字来添加代码下载按钮：

Markdown
1 2	```download print("Hello, World!")

代码注释¶

使用 comment 关键字来添加代码注释：

Markdown
1 2 3	```comment # 这是一个注释 print("Hello, World!")

代码标签¶

使用 tags 关键字来添加代码标签：

Markdown
1 2	```tags print("Hello, World!")

代码语言¶

使用 language 关键字来指定代码语言：

Markdown
1 2	```language="python" print("Hello, World!")

代码主题¶

使用 theme 关键字来指定代码主题：

Markdown
1 2	```theme="dark" print("Hello, World!")

代码样式¶

使用 style 关键字来指定代码样式：

Markdown
1 2	```style="monokai" print("Hello, World!")

代码块内嵌¶

使用 embed 关键字来内嵌代码块：

Markdown
1 2	```embed print("Hello, World!")

代码块折叠¶

使用 fold 关键字来折叠代码块：

Markdown
1 2	```fold print("Hello, World!")

代码块行号¶

使用 number 关键字来显示代码块行号：

Markdown
1 2	```number print("Hello, World!")

代码块标题¶

使用 header 关键字来添加代码块标题：

Markdown
1 2	```header="example.py" print("Hello, World!")

代码块副本按钮¶

使用 duplicate 关键字来添加代码块副本按钮：

Markdown
1 2	```duplicate print("Hello, World!")

代码块下载按钮¶

使用 save 关键字来添加代码块下载按钮：

Markdown
1 2	```save print("Hello, World!")

代码块注释¶

使用 remark 关键字来添加代码块注释：

Markdown
1 2 3	```remark # 这是一个注释 print("Hello, World!")

代码块标签¶

使用 label 关键字来添加代码块标签：

Markdown
1 2	```label print("Hello, World!")

代码块语言¶

使用 syntax 关键字来指定代码块语言：

Markdown
1 2	```syntax="python" print("Hello, World!")

代码块主题¶

使用 scheme 关键字来指定代码块主题：

Markdown
1 2	```scheme="dark" print("Hello, World!")

代码块样式¶

使用 format 关键字来指定代码块样式：

Markdown
1 2	```format="monokai" print("Hello, World!")