slightc/OneDocCenter

个人的文档记录中心

个人文档中心

文档使用markdown编辑,使用mkdocs框架,material主题

文档编辑环境

环境需要安装python,mkdocs参考文档见链接, 默认python环境已经安装(python2与python都可以)

环境使用如下命令安装

Linux下使用命令

pip install mkdocs --user
pip install mkdocs-material --user
pip install pygments --user

Windows下使用命令

pip install mkdocs
pip install mkdocs-material
pip install pygments

如果python的markdown版本过低,使用下面命令升级markdown

Linux

pip install --upgrade markdown --user

Windows

pip install --upgrade markdown

文档预览

在此目录下执行下面命令

mkdocs serve

将在本地8000端口开启网页服务,通过浏览器就可以访问文档, 源文档文件修改保存后预览将实时更新

文档发布

使用

mkdocs gh-deploy

文档将打包发布在page页面