基于mkdocs-material实现的帮助文档

# 安装依赖

pip install mkdocs mkdocs-material
pip install jieba
# 本地调试
mkdocs serve
# 打包
mkdocs build

 

mkdocs.yml的内容：

site_name: 项目协作平台使用指南
copyright: Copyright  2020 The Project by TiChu. All Rights Reserved
nav:
- '快速入门':
- '入门概述': 'kuaisurumen/gaishu.md'
- '创建账号': 'kuaisurumen/createuser.md'
- '创建项目': 'kuaisurumen/createproject.md'
- '用户手册':
- '平台介绍': 'handbook/introduce.md'
- '项目协作平台统一门户（Portal）': 'handbook/index.md'
- '系统管理': 'handbook/systemmanage.md'
- '项目管理':
- '项目概览': 'handbook/projectmanage/gailan.md'
- '项目计划': 'handbook/projectmanage/jihua.md'
- '需求': 'handbook/projectmanage/xuqiu.md'
- '任务': 'handbook/projectmanage/renwu.md'
- '缺陷': 'handbook/projectmanage/quexian.md'
- '迭代': 'handbook/projectmanage/diedai.md'
- '看板': 'handbook/projectmanage/kanban.md'
- '测试跟踪': 'handbook/projectmanage/testcase.md'
- '知识库': 'handbook/projectmanage/wiki.md'
theme:
name: 'material'
dev_addr: 0.0.0.0:5555

 

参考：
https://segmentfault.com/a/1190000018592279?utm_source=tag-newest