快速开始

安装

pip install mkdocs
pip install mkdocs-material  # 推荐主题

初始化

mkdocs new my-docs
cd my-docs
mkdocs serve

目录要点：

• mkdocs.yml：站点配置、导航。
• docs/：Markdown 内容。

配置示例

site_name: My Docs
theme:
  name: material
nav:
  - 主页: index.md
  - 指南:
    - 开始: guide/start.md
    - API: guide/api.md

构建与部署

• 构建：mkdocs build 输出 site/。
• 部署：将 site/ 上传到任意静态托管（CF Pages/Netlify/Vercel/GitHub Pages）。 Code/CI 里也可用 mkdocs gh-deploy。***