扩展¶

Markdown是一种非常小的语言，有一种参考实现，称为 [约翰·格鲁伯的Markdown]。Python Markdown和[Python Markdown扩展] 是两个增强Markdown写作体验的包，增加了有用的技术写作的语法扩展。

支持的扩展¶

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

配置¶

扩展配置为“mkdocs.yml”的一部分，即mkdocs配置文件。以下部分包含引导的两个示例配置您的文档项目。

最小配置¶

当您使用Material时，此配置是一个很好的起点首次使用MkDocs。最好的办法是探索[参考]，以及逐步添加您想要使用的内容：

markdown_extensions:

  # Python Markdown
  - toc:
      permalink: true

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

推荐配置¶

此配置启用了MkDocs Material的所有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