大家好，我是小 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，目前每天都會在上面更新文章，專注于分享比較實用的開發工具與開源項目，偶爾也會聊聊技術圈內最近發生的新鮮事，感興趣的小伙伴可以關注一下哈。

總結

以上是生活随笔為你收集整理的github创建项目_用了 GitHub 上这款开源神器后，创建项目文档变得 so easy！的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。