配置¶

MkDocs 的配置文件是 mkdocs.yml，位于项目根目录。

基本配置¶

site_name: 我的文档
site_description: 网站描述
site_author: 作者名称
site_url: https://example.com

主题配置¶

theme:
  name: material
  language: zh
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
    - scheme: slate
      primary: indigo
      accent: indigo

导航配置¶

nav:
  - 首页: index.md
  - 指南:
      - 快速开始: guide/quick-start.md
      - 高级用法: guide/advanced.md

插件配置¶

plugins:
  - search:
      lang:
        - zh
        - en

Markdown 扩展配置¶

markdown_extensions:
  - pymdownx.highlight
  - pymdownx.superfences
  - admonition
  - pymdownx.details

提示

更多配置选项请参考 MkDocs 官方文档和 Material 主题文档。