跳转至

Formatting 设置格式

Material for MkDocs 支持多种 HTML 元素,可用于突出文档中的部分内容或应用特定的格式。此外,还支持 Critic Markup,可以显示文档的建议更改内容。 TODO:进一步了解,目前有些不理解

使用方法

高亮更改内容

启用 Critic 后,可以使用 Critic Markup,从而突出显示建议的更改并在文档中添加内联评论。

格式设置样例
文本可以被删除,还可以被添加。这些格式特性还可以被结合进结合在一个单独的表达式中。你还可以利用此扩展高亮一些内容而且你还可以在这里塞一些内联评论


格式化也可以应用于块级内容:
将起始和结束标记放在单独的行上,并在标记与内容之间添加新行即可。


上面的语法渲染结果如下:

文本可以被删除,还可以被添加。这些格式特性还可以被结合进结合在一个单独的表达式中。你还可以利用此扩展高亮一些内容而且你还可以在这里塞一些内联评论

格式设置也可以应用于块级内容。 将起始和结束标记放在单独的行上,并在标记与内容之间间隔一行即可。

高亮文本内容

启用 Caret、Mark 和 Tilde 后,可以通过简单的语法高亮文本,这种方法比直接使用 HTML 标签(如 <mark><ins><del>)要便捷些。

格式设置样例
- ==这部分等同于HTML的`<mark>`标签(高亮)==
- ^^这部分等同于HTML的`<ins>`标签(下划线)^^
- ~~这部分等同于HTML的`<del>`标签(删除线)~~

渲染结果如下:

  • 这部分等同于HTML的<mark>标签(高亮)
  • 这部分等同于HTML的<ins>标签(下划线)
  • 这部分等同于HTML的<del>标签(删除线)

上下标

启用 Caret 和 Tilde 后,可以通过简单的语法实现上下标。类似地,这比直接使用 HTML 标签(如 <sub><sup>)要更便捷些。

格式设置样例
<!-- 下标 -->
- H~2~O
<!-- 上标 -->
- A^T^A

渲染结果如下:

  • H2O
  • ATA

添加键盘按键

未做研究,详见Adding keyboard keys.