ReadTheDocsNote

• 使用ReadTheDocs构建托管技术文档
  • 前置准备
  • Github新建项目
  • Sphinx安装与测试
  • 使用Typora编写md文档
  • 使用VScode编写MarkDown
  • 编写编译所需的文件
  • ReadTheDocs新建项目
  • 自动构建

Sample Markdown

• Sample
  • 一级标题
    • 二级标题
      • 三级标题
        • 四级标题
          • 五级标题

开源示例

• Github

• Gitee

Indices and tables

• 索引

• 模块索引

• 搜索页面