本仓库不再维护，更新的内容前往：ZJDoc/DocGuide

mkdocs-github-readthedocs

mkdocs文档制作，github远程托管，readthedocs在线发布

内容列表

• 本仓库不再维护，更新的内容前往：ZJDoc/DocGuide
• mkdocs-github-readthedocs
  • 内容列表
  • 背景
  • 安装
  • 用法
  • 主要维护人员
  • 致谢
  • 参与贡献方式
  • 许可证

背景

sphinx-github-readthedocs：

CSDN编辑、发布文章不方便，想要找一个本地文档生成工具，最好支持Markdown，同时能够找一个在线发布网站，方便浏览
Sphinx+Github+Readthedocs能够满足要求

参考MkDocs vs Sphinx，使用MkDocs替换Sphinx

安装

文档本地编译需要预先安装以下工具：

$ pip install mkdocs

用法

有两种使用方式

1. 在线浏览文档：mkdocs+github+readthedocs

2. 本地浏览文档，实现如下：

   $ git clone https://github.com/zjZSTU/mkdocs-github-readthedocs.git
   $ cd mkdocs-github-readthedocs
   $ mkdocs serve
   

   启动本地服务器后即可登录浏览器localhost:8000

主要维护人员

• zhujian - Initial work - zjZSTU

致谢

参与贡献方式

欢迎任何人的参与！打开issue或提交合并请求。

注意:

• GIT提交，请遵守Conventional Commits规范
• 语义版本化，请遵守Semantic Versioning 2.0.0规范
• README编写，请遵守standard-readme规范

许可证

Apache License 2.0 © 2019 zjZSTU