文档书写 - mkdocs

github.io 主题

themes minimal 左侧有不动的侧边栏 slate 黑白主题，还可以 time-machine 上下滑动的时候有吸顶 architect 样式还可以 cayman 整体感觉最好 还是太麻烦了

gitbook安装

npm install -g gitbook-cli
# 新建目录，进入目录后执行
gitbook init
# 组织子目录结构，然后编辑markdown文件
# summary.md 是目录文档， 编辑完成后生成html
gitbook build [书籍路径] [输出路径]
# 如果像生成PDF
gitbook pdf ./ book.pdf

各种问题， 无法顺利使用

mkdocs

getting-started

pip install mkdocs
# 直接进入项目目录，创建mkdocs.yml以及docs子目录即可
mkdocs build
# 生成静态文件在site目录下

mkdocs.yml 可参考官方文档，示例：

site_name: XXXX
site_url: http://xxxx.com
nav:
    - xxx: index.md
    - 介绍: intro.md
    - 关于: about.md

theme: readthedocs