# mkdocs

> 使用 Markdown 的项目文档。
> 更多信息：<https://www.mkdocs.org>。

- 创建一个新的 mkdocs 项目：

`mkdocs new {{project_name}}`

- 在当前目录中使用 mkdocs 开发服务器提供项目：

`mkdocs serve`

- 在当前目录中构建文档：

`mkdocs build`

- 将当前目录中的文档部署到 GitHub 页面：

`mkdocs gh-deploy`