扩展¶

Markdown 是一种非常小的语言，具有一种称为 John Gruber's Markdown 的参考实现。Python Markdown 和 Python Markdown Extensions 是两个增强 Markdown 写作体验的包，为技术写作添加了有用的语法扩展。

支持的扩展¶

以下扩展均由 Material for MkDocs 支持，因此强烈推荐使用。点击每个扩展以了解其目的和配置：

配置¶

扩展在 mkdocs.yml 中配置，这是 MkDocs 的配置文件。以下部分包含两个示例配置，以启动您的文档项目。

最小配置¶

此配置是您第一次使用 Material for MkDocs 时的良好起点。最好的办法是探索参考，逐渐添加您想使用的内容：

markdown_extensions:

  # Python Markdown
  - toc:
      permalink: true

  # Python Markdown Extensions
  - pymdownx.highlight
  - pymdownx.superfences

推荐配置¶

此配置启用 Material for MkDocs 的所有与 Markdown 相关的功能，非常适合经验丰富的用户启动新的文档项目：

markdown_extensions:

  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true

  # Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde