安装live server(有vscode的同学里面有插件,直接安装)
- 使用命令行(cmd+R)
npm install live-server live-server --port=9999
- 会自动弹出页面,然后选择build->html
具体示例
-
修改某个md文件,添加test.md文件夹并写下以下内容
test ==== # test hello world!
-
修改index.md文件,添加目录
.. toctree:: :maxdepth: 2 :caption: test: test
-
执行固定命令,live-server 一直开着,下面命令执行完后刷新,页面就会有变化
make clean make html
-
通过本地查看效果
http://127.0.0.1:7749/build/html/test.html
-
如果本地效果ok,就可以上传到github
make clean make html rm -rf docs/** touch docs/.nojekyll cp -r build/html/* docs/
视频
使用Sphinx搭建本地(window)文档并把它部署到网上(github)成为blog
上两篇:
[使用Sphinx搭建本地(window)文档并把它部署到网上(github)-本地搭建(1)](https://blog.csdn.net/u013716535/article/details/104902308)
[使用Sphinx搭建本地(window)文档并把它部署到网上(github)-布置主题并发布(2)](https://blog.csdn.net/u013716535/article/details/104907240)
参考链接
[1]http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html
[2]https://www.jianshu.com/p/dfbae1a64614