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
 

文章来源: pengshiyu.blog.csdn.net，作者：彭世瑜，版权归原作者所有，如需转载，请联系作者。

原文链接：pengshiyu.blog.csdn.net/article/details/103669218