MkDocs

專案文件與 Markdown。


MkDocs 是用於建立專案文件的快速簡潔,而且非常棒的靜態網站產生器。文件原始檔寫在 Markdown,並用單一 YAML 組態檔做組態。先從閱讀 入門教學 開始,接著查看 使用者指南 取得更多資訊。

功能

可用的精選佈景主題

有很多外觀精美的 佈景主題 可用於 MkDocs。從內建的佈景主題進行選擇:mkdocsreadthedocs,從 MkDocs 佈景主題 wiki 頁面和 MkDocs 目錄 中選擇第三方佈景主題,或是 建立自己的佈景主題

易於自訂

透過 自訂您的佈景主題 和/或安裝部分 外掛程式,讓您的專案文件看起來就像您想要的樣子。用 Markdown 擴充 來修改 Markdown 的行為。有許多 組態選項 可用。

在作業時預覽您的網站

內建的開發伺服器讓您在撰寫文件時可以預覽。每當您儲存變更,它甚至會自動重新載入並更新您的瀏覽器。

任何地方都能主機

MkDocs 會建置出完全靜態的 HTML 網站,您可以將這些網站主機在 GitHub Pages、Amazon S3,或 任何 您選擇的地方。