格式化¶

Material for MkDocs 提供对多种 HTML 元素的支持，这些元素可以用来突出文档的某些部分或应用特定的格式。此外，支持 Critic Markup，增加了显示文档建议更改的能力。

配置¶

此配置启用对键盘按键的支持、文档中的更改跟踪、定义下标和上标以及文本高亮。将以下行添加到 mkdocs.yml 中：

markdown_extensions:
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde

查看其他配置选项：

• Critic
• Caret, Mark & Tilde
• Keys

使用¶

突出更改¶

当启用 Critic 时，可以使用 Critic Markup，它增加了突出显示建议更改的能力，以及向文档添加行内评论的功能：

文本可以是 {--删除--}，替换文本 {++添加++}。这也可以组合成 {~~一个~>单个~~} 操作。{==高亮==} 也是可能的 {>>并且可以添加行内评论<<}。

{==

格式化也可以应用于块，通过将开始和结束标签放在单独的行上，并在标签与内容之间添加新行。

==}

突出文本¶

当启用 Caret, Mark & Tilde 时，可以使用简单的语法来突出文本，这比直接使用相应的 mark、ins 和 del HTML 标签更方便：

- ==这被标记了（高亮）==
- ^^这被插入了（下划线）^^
- ~~这被删除了（删除线）~~

下标和上标¶

当启用 Caret & Tilde 时，可以使用简单的语法为文本添加下标和上标，这比直接使用相应的 sub 和 sup HTML 标签更方便：

- H~2~O
- A^T^A

添加键盘按键¶

当启用 Keys 时，可以使用简单的语法渲染键盘按键。请查阅 Python Markdown Extensions 文档以了解所有可用的简写：

++ctrl+alt+del++