MkDocs 是一个用于创建项目文档的静态站点生成器。文档源码使用 Markdown 来撰写,经配置后,可自动生成具有目录结构的站点,常用来撰写技术文档、个人博客。

本教程的结构如下:

  • MkDocs 简介

  • MkDocs 快速入门

  • 安装 MkDocs
  • 创建项目
    • 新建项目
    • 启动服务
    • 添加页面
    • 本地预览
  • 发布站点
    • Github Pages
    • readthedocs
  • MkDocs 进阶操作
  • 文档布局
    • 初始结构
    • 设置多级目录
  • 主题配置

    • 更改主题
    • 自定义主题
  • 附录

  • 在技术文档写作中使用 Git
  • 在技术文档写作中使用 GitHub Desktop
  • Markdown 基础语法