一 简要介绍 recommonmark是个到commonMark文档的兼容性桥,那么什么是commonMark是什么的呢?CommonMark是规范版的markdown,下边是部分commonmark的学习链接,供学习参考: commonmark规范 https://spec.commonmark.org/ commonmark帮助 https://commonmark.org/help/ commonmark教程 https://commonmark.org/help/tutorial/ co…

一.文档撰写前提 环境部署: > git clone https://github.com/toooney/demo-readthedocs.git > pip install sphinx recommonmark sphinx-autobuild sphinx_rtd_theme -i http://mirrors.aliyun.com/pypi/simple/ --trusted-host=mirrors.aliyun.com 二.撰写博文并发表 把你要发表的博文放在 demo-read…

ReadtheDocs Read the Docs非常适合写软件文档以及编写一些教程.电子书之类.对于一些一两篇文章就能写清楚的可以记笔记或写博客, 但是如果要写成一个系列的,不如写成一本书的形式,更美观,也更系统. Read the Docs是一个在线文档托管系统, 你可以从各种版本控制系统中导入文档,如果你使用webhooks, 那么每次提交代码后可以自动构建并上传至readthedocs网站,非常方便. 现有的写电子书的方式,有以下几个解决方案,优劣势也很明显: 写博客,跟散文堆在一起,不…

gitbook生成的html目录不折叠且链接失效 装好了gitbook和nodejs,本以为可以安心的做电子书了. 谁想到gitbook慢的一P,而且导出来的html目录不折叠,最关键的是链接有问题,用不了,无语. 目录折叠可以用一个插件toggle-chapters.或者用这个作者的方法. 而链接用不了,很少有记录有人处理过这个问题.这里有一个可以用,但是要每次都处理,而且他的目录居然是每次点击都要刷新加载,太慢了,不符合潮流啊 .https://blog.csdn.net/yageeart/…

希望在readthedocs上创建支持多语言的文档,效果类似: 通过语言选项,可以切到到不同的语言版本:实现这个目标包含两个主要步骤: 在本地对文档进行翻译 在readthedocs.org上配置翻译 本文假设您已经对sphinx文档生成工具和readthedocs.org文档托管网站有所了解,本文主要专注于多语言的配置上. 在本地对文档进行翻译 翻译之前需要安装一些软件包: sphinx: 文档生成工具 sphinx_intl: 多语言工具 recommonmark: sphinx支持mark…

目录 1.什么是Gitlab Pages 2.开启Gitlab Pages 3.基本过程 4.托管markdown文档 4.1 安装sphinx等依赖 4.2 配置项目的sphinx配置 4.3 编写项目文档 4.4 创建首页索引 4.5 配置gitlab-ci.yml 4.6 生成网页 4.7 配置DNS或者hosts文件 5.预览和调试 5.1 直接使用sphinx命令生成网页 5.2 VScode+sphinx插件预览 5.3 下载Gitlab生成的网页 总结 这段时间准备软考去了,也挺久…

简介 Sphinx 是一个 文档生成器 ,您也可以把它看成一种工具,它可以将一组纯文本源文件转换成各种输出格式,并且自动生成交叉引用.索引等.也就是说,如果您的目录包含一堆 reStructuredText 或 Markdown 文档,那么 Sphinx 就能生成一系列HTML文件,PDF文件(通过LaTeX),手册页等. 安装 pip install sphinx 查看是否安装成功 sphinx-build --version 显示对应的版本号即代表安装成功 sphinx-build 5.0.…