内置排版插件¶

排版插件允许在导航和目录中保留标题和小标题的丰富展示。这意味着代码块、图标、表情符号以及任何其他内联格式都可以按页面内容中定义的方式准确呈现。

内置排版插件已弃用

Material for MkDocs 处于维护模式。排版插件曾是 Insiders 版本的一部分，于 9.7.0 发布，这是包含 Insiders 版本所有功能的最后一次发布。不幸的是，排版插件被证明无法维护，并且是创建 Zensical 的主要动机之一。

如果您正在考虑使用排版插件，请注意已知问题将不会被修复.

目标¶

在构建您的项目时，MkDocs 从标题中提取纯文本并丢弃原始格式。这通常是有用的好主意，因为这些信息可以提供给其他插件，而这些插件在接收 HTML 而不是纯文本时可能会遇到问题。

然而，这也意味着整个格式会丢失。

该插件钩入渲染过程，提取原始标题，并使其可用于模板和插件。Material for MkDocs 的模板使用这些信息来渲染导航和目录的丰富版本。

通常建议使用该插件，因为它是一个即插即用的解决方案，不需要任何配置，并且旨在开箱即用。由于它不会覆盖而只是添加信息，因此不期望与其他插件发生冲突。

与所有内置插件一样，开始使用排版插件非常简单。只需将以下行添加到 mkdocs.yml 中，即可观察到丰富的导航和目录：

plugins:
  - typeset

排版插件内置于 Material for MkDocs 中，无需单独安装。

以下设置可用：

9.7.0 true

使用此设置在构建您的项目时启用或禁用插件。通常不需要指定此设置，但如果您想禁用插件，请使用：

plugins:
  - typeset:
      enabled: false