MkDocs is a documentation generator that focuses on speed and simplicity. It has many great features including:

• Preview your documentation as you write it
• Easy customization with themes and extensions
• Writing documentation with Markdown

安装环境

$ pip3 install mkdocs

创建文档

$ mkdocs new project_doc

编译文档

$ mkdocs serve

打开离线文档:

• http://127.0.0.1:8000/

GitHub 代码托管

$ touch .gitignore
$ git init
$ git add .
$ git remote add origin git:/github.git
$ git push -u origin master

绑定 Read the Docs

1. Import your docs.
2. Read the Docs dashboard
3. Import

版本管理

• Version Doc

资源

• MkDocs documentation
• Markdown syntax guide
• Writing your docs with MkDocs