MkDocs 是一個靜態網站產生器,專門用於建立文件網站。MkDocs 以 Python 程式語言撰寫,是一個擁有大量社群支援的開源專案。有各種不同的 佈景主題 可供使用。在 Markdown 支援方面,MkDocs 在支援基本語法元素方面做得很好,但它缺乏對某些進階語法元素的支援。
此應用程式使用 Python-Markdown Markdown 處理器。你可以啟用其他 擴充功能。
MkDocs 提供對以下 Markdown 元素的支援。
元素 | 支援 | 備註 |
---|---|---|
標題 | 是 | |
段落 | 是 | |
換行 | 是 | |
粗體 | 是 | |
斜體 | 是 | |
區塊引用 | 是 | |
編號清單 | 是 | |
未編號清單 | 是 | |
程式碼 | 是 | |
水平分隔線 | 是 | |
連結 | 是 | |
圖片 | 是 | |
表格 | 是 | |
圍欄式程式碼區塊 | 是 | |
語法高亮 | 是 | |
註腳 | 否 | |
標題 ID | 否 | |
定義清單 | 否 | |
刪除線 | 否 | |
工作清單 | 否 | |
表情符號(複製貼上) | 未知 | |
表情符號(簡碼) | 未知 | |
重點標示 | 否 | |
下標 | 否 | |
上標 | 否 | |
自動網址連結 | 是 | |
停用自動網址連結 | 是 | |
HTML | 是 |
以下是一個方便的功能:你可以啟用一個擴充功能,在 MkDocs 中使用 警語。這是一個快速簡便的方法,可以在你的 MkDocs 網站上開始使用注意事項、警告和提示。請參閱此 GitHub 議題 以取得更多資訊和範例。
在 60 頁中學習 Markdown。Markdown 指南 一書專為新手和專家設計,是一本全面的參考書,包含你入門和精通 Markdown 語法所需的一切內容。
取得這本書現在別停下來!🚀 標示 GitHub 儲存庫,然後在下方輸入你的電子郵件地址,以透過電子郵件接收新的 Markdown 教學課程。絕無垃圾郵件!