mkdocs生成项目文档

mkdocs是一个项目文档生成器

文档：https://www.mkdocs.org/

安装

pip install mkdocs

1

创建项目

mkdocs new my-project cd my-project

1

2

项目目录

. ├── docs │ └── index.md ├── mkdocs.yml

1

2

3

4

运行服务

$ mkdocs serve

1

http://127.0.0.1:8000/

文档生成

mkdocs build mkdocs build --clean

1

2

部署到github

# 先推到master分支 echo "site/" >> .gitignore git init git add . git commit -m "add" git push # 再进行部署 mkdocs gh-deploy

1

2

3

4

5

6

7

8

9

10

一个不错的主题

pip install mkdocs-material

1

mkdocs.yml配置示例

site_name: 项目文档 nav: - 主页: index.md - 关于: about.md theme: name: 'material' language: 'zh' extra: social: - type: 'github' link: 'https://github.com/mouday'

1

2

3

4

5

6

7

8

9

10

11

12

13

14

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。