MkDocs

mkdocs.org官网已核对

用 Markdown 写项目文档的静态站点生成器,配置集中在一个 YAML 文件,内置两套主题并支持插件与 Markdown 扩展,本地预览保存即自动刷新,适合把文档和代码放在同一仓库、改完提交就发布的开发者。

打开官网替代品 12 个 本站 11 月 22 日 实测可以打开
最近 5 次实测

5 次可以打开平均 4.0 秒

本站从国内机房定期实测。竖条由远及近:绿 = 可以打开,橙 = 国内不可直接访问,灰 = 打不开。
mkdocs.orgMkDocs 首页截图

mkdocs.org 首页 · 本站实拍 · 点开看大图

MkDocs 是一个静态站点生成器,专门用来搭项目文档。文档源文件用 Markdown 写,整站配置集中在一个 YAML 文件里,跑一条命令就能把 Markdown 编译成一套静态 HTML 页面。它面向的是写代码文档的人:README 越写越长、需要分章节和搜索时,用它把一堆 .md 文件组织成有导航的站点。

主要功能

内置 mkdocs 和 readthedocs 两套主题,也可以从 MkDocs Themes 维基页和 MkDocs Catalog 里挑第三方主题,或者自己写。主题之外还能装插件、开 Markdown 扩展,改 Markdown 的渲染行为,配置项不少。

写作过程中可以起内置的开发服务器预览站点,保存文件后浏览器自动重载刷新,不用手动刷新看效果。

构建产物是纯静态 HTML,可以放到 GitHub Pages、Amazon S3 或任何能托管静态文件的地方。

适合谁

适合把文档和代码放在同一个仓库、改完提交就发布的开发者。文档用 Markdown 写,和代码一起走版本管理,构建出来的站点不依赖后端。

版本与许可

页面版权信息显示项目始于 2014 年,作者 Tom Christie,现由 MkDocs Team 维护。发布记录里最新版本是 1.6.1(2024-08-30)。站点本身也是用 MkDocs 构建的。

常见问题

MkDocs 收费吗?
MkDocs 免费使用。
用 MkDocs 要登录吗?
不用登录就能用。

替代品全部 12 个,带对比表 →

替代品 12打开官网