背景
花了2天操作hexo,都没弄熟悉,时间上性价比不高。正好也找到如何在sphinx里面使用md的方法,还是用回sphinx好了。网上很多在线工具可以直接互相转换两种格式。
为什么要用markdown格式,因为github,csdn,公众号现在都可以支持,那么写一份文档就可以多平台发布,更高效。
操作
- pip install --upgrade recommonmark
- conf.py文件修改
2.1 extensions = [‘recommonmark’]
2.2 source_suffix = [’.rst’, ‘.md’] - 有很多坑,比如主题版本和recommonmark不适应
- 如果md里面很多一级标题,那么都会展示在左边目录,所以建议只写一个一级标题作为主题。
- 安装插件,vscode可以直接预览md格式,找到一个md文件,右键选择open preview就可以
- 安装插件,vscode可以直接预览rst格式,找到一个rst文件,右键选择open preview就可以
- 这个文档会持续更新
参考资料
[1]http://www.sphinx-doc.org/en/master/usage/markdown.html
[2]https://www.xncoding.com/2017/01/22/fullstack/readthedoc.html