MkDocs简介

MkDocs静态文档网站生成器 是非常适合构建项目文档的MarkDown工具:

  • MarkDown格式非常流行,简单易用(比 Sphinx文档 采用的reStructuredText功能强大但非常复杂),所以可以非常快速完成文档速记

  • 我曾经尝试过各种笔记(知识库)软件,虽然商业软件,如EverNote, OneNote等非常好用,但是捆绑在闭源软件或平台,会导致迁移成本非常高昂,且很难实现跨平台

  • 我需要一个完全自由的撰写平台

我在工作中,常用MarkDown格式记录文档,并且这个格式也是公司内部文档的通用撰写格式。自然而然,我也就想到使用MarkDown作为个人工作笔记的格式,自然而然就会选择开源静态文档生成工具 MkDocs静态文档网站生成器

基于mkdocs-material搭建个人静态博客(含支持的markdown语法) 提供了非常好的使用指南,非常推荐参考