大家好，我是小 G。

今天跟大家分享一个可用于快速创建项目文档的开源神器：MkDocs。

https://github.com/mkdocs/mkdocs

该项目创建自 2014 年，目前 GitHub 上参与维护开发，给项目提交贡献的开发者，共有 100 多名，其 GitHub Star 数也达到了 9600+，估计很快就破万了。

这款工具希望能帮助开发者以更加快速、便捷的方式来创建项目文档，并为其生成更加简洁直观的静态站点。

此外，开发者还贴心的针对国内开发者提供了中文文档。

MkDocs 中文文档

在这一过程中，工程师无需进行过多编码操作，仅通过 Markdown 和 YAML 即可快速完成项目文档的撰写与配置。其主要核心功能如下：

任意托管

构建完全的静态 HTML 站点 , 可以将它托管到 GitHub ages, Amazon S3 等任意地方。

大量主题

默认包含大量美观的主题. 可以从 bootstrap, readthedocs 和 12 款 bootswatch 主题中选择。

即时预览

内建的开发服务器使你在撰写文档的时候就即时预览。它甚至能在保存更改时自动载入, 只需刷新浏览器就可以查看更改。

易于配置

可以快速配置文档主题。

交叉索引

使用 MkDocs 链接语法创建交叉索引。

---

现在工具给你们找来了，可以赶紧让同事把拖欠的文档补上了...

最后安利一波我们的公众号：GitHubDaily，目前每天都会在上面更新文章，专注于分享比较实用的开发工具与开源项目，偶尔也会聊聊技术圈内最近发生的新鲜事，感兴趣的小伙伴可以关注一下哈。