mkdocs

MK文檔

使用 Markdown 編寫專案文檔

MkDocs 是一個快速、簡單且華麗的靜態網站產生器，適用於建立專案文件。文件原始檔是用 Markdown 編寫的，並使用單一 YAML 設定檔進行設定。它的設計易於使用，並且可以透過第三方主題、外掛程式和 Markdown 擴充功能進行擴充。

請參閱文件以取得介紹性教學課程和完整的使用者指南。

特徵

• 從 Markdown 文件建立靜態 HTML 文件。
• 使用外掛程式和 Markdown 擴充功能來增強 MkDocs。
• 使用內建主題、第三方主題或建立您自己的主題。
• 在可以提供靜態文件的任何地方發布您的​​文件。
• 還有更多！

支援

如果您需要 MkDocs 方面的協助，請隨時與我們聯繫！

• 對於問題和高級討論，請使用 GitHub 上的討論。
  • 對於小問題，Gitter/Matrix 上的聊天室是一個不錯的選擇。
• 若要回報錯誤或提出功能請求，請在 GitHub 上開啟問題。

請注意，我們可能只為 MkDocs 核心功能的問題提供支援。有關第三方主題、外掛程式、擴充功能或類似功能的任何問題或錯誤報告應針對其各自的項目進行。
但是，聊天室並沒有禁止此類問題。

請務必留下來回答一些問題！

連結

• 官方文檔
• 最新發行說明
• 第三方外掛程式、主題和配方目錄

為 MkDocs 做出貢獻

MkDocs 專案歡迎並依賴開源社群中的開發人員和使用者的貢獻。請參閱貢獻指南以獲取有關如何提供協助的資訊。

行為守則

在 MkDocs 專案的程式碼庫、問題追蹤器和討論論壇中進行互動的每個人都應遵循 PyPA 行為準則。

執照

BSD-2 條款