MkDocs 快速入门

By TJ@2020.12.03

MkDocs使用Markdown语法进行标记文档写作。

安装MkDocs

假定你已经安装了Python，接下来安装MkDocs:

$ pip install mkdocs

初始化文档项目

初始化你的Mkdocs项目

$ mkdocs new .

这个命令会建立 mkdocs.yml 配置文件，以及 docs/index.md 的Makrdown文件（你文档的入口，你可以进一步编辑它）。

构建并生成预览(web)

编译文档

$ mkdocs serve

这个命令把你的所有Makdown 文件生成HTML，并启动一个开发环境服务器，可以在浏览器浏览你的文档。 在你的浏览器打开： http://127.0.0.1:8000/

你可以修改Markdown文件，你的文档会自动重新构建(rebuild)。