ReadtheDocs 项目用 markdown 格式来书写文档

🌙
手机阅读
本文目录结构

场景

公司的一个项目

项目地址:http://dev.canonchain.com/

需要做一些文档,用来帮助开发者;

需要用到多版本 / 多语言的文档管理

所以使用 ReadtheDocs 来实现这个需求;

但是使用的时候,因为默认是用 rst 格式的,不支持 markdown,而我们团队对 markdown 更有好感;

所以做了 markdown 的兼容

解决方案

默认不支持 markdown 写法,需要安装recommonmark插件

pip install recommonmark

还需要修改 conf.py 文件

#编辑配置文件source/conf.py在最后一行复制下方配置
from recommonmark.parser import CommonMarkParser
source_parsers = {
    '.md': CommonMarkParser,
}
source_suffix = ['.rst', '.md']

具体的位置如下

然后就可以正常使用了,剩下就是编译部署的事情了;


AXIHE / 精选资源

浏览全部教程

面试题

学习网站

前端培训
自己甄别

前端书籍

关于朱安邦

我叫 朱安邦,阿西河的站长,在杭州。

以前是一名平面设计师,后来开始接接触前端开发,主要研究前端技术中的JS方向。

业余时间我喜欢分享和交流自己的技术,欢迎大家关注我的 Bilibili

关注我: Github / 知乎

目前重心已经放在研究区块链上面了

我叫朱安邦,阿西河的站长

目前在杭州从事区块链周边的开发工作,机械专业,以前从事平面设计工作。

2014年底脱产在老家自学6个月的前端技术,自学期间几乎从未出过家门,最终找到了满意的前端工作。更多>