快速开始

欢迎使用 MkDocs 文档框架！本文将引导您快速上手。

什么是 MkDocs？

MkDocs 是一个快速、简单的静态站点生成器，专注于构建项目文档。Markdown 源文件使用 Markdown 语法编写，并使用单个 YAML 配置文件进行配置。

安装

pip install mkdocs mkdocs-material

创建新项目

mkdocs new my-project
cd my-project
mkdocs serve

构建站点

mkdocs build

构建后的静态文件会输出到 site/ 目录。

部署

使用 mkdocs gh-deploy 可直接部署到 GitHub Pages：

mkdocs gh-deploy