扩展

Markdown 是一种非常小的语言，有一种参考实现叫做[John Gruber 的 Markdown]。Python Markdown和[Python Markdown 扩展]是两个增强 Markdown 写作体验的包，为技术写作添加有用的语法扩展。

支持的扩展

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

• 缩略语
• 警告
• Arithmatex
• 属性列表
• BetterEm
• 插入符号、标记和波浪线
• Critic
• 定义列表
• 详情
• 表情
• 脚注
• 高亮
• 键
• 在HTML中使用Markdown
• 智能符号
• 代码片段
• 超级围栏
• 标签页
• 目录
• 表格
• 任务列表

配置

扩展作为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:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.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