實用的外掛

MkDocs 的核心功能雖然精簡，但透過強大的 Plugin 生態系，你可以針對特定需求進行功能增強。以下推薦幾款在撰寫技術筆記或開發文件時幾乎必備的插件。

如何安裝與啟用 Plugin

所有的 Plugin 都需要透過 Python 的 pip 進行安裝，並在 mkdocs.yml 設定檔中啟用。

通用安裝指令

pip install [plugin-name]

設定檔啟用方式

在 mkdocs.yml 中新增 plugins 區塊：

plugins:
  - search        # 內建搜尋功能（必備）
  - [plugin-name] # 填入你想啟用的插件名稱

精選必裝插件清單

1. 圖片縮放 (Medium Zoom)

讓讀者點擊筆記中的圖片時，能以燈箱效果放大查看，適合展示精細的架構圖。

• 套件名稱：mkdocs-medium-zoom
• 用途：改善圖片閱讀體驗。

2. Git 資訊整合 (Revision Date)

自動在頁面底部顯示該文件在 Git 上的最後修改時間，增加筆記的時效參考價值。

• 套件名稱：mkdocs-git-revision-date-localized-plugin
• 設定範例：

  plugins:
    - git-revision-date-localized:
        enable_creation_date: true
        type: datetime
  

3. 自動生成 PDF (PDF Export)

將你的所有筆記頁面打包成一份專業的 PDF 文件，方便離線閱讀或列印。

• 套件名稱：mkdocs-pdf-export-plugin
• 用途：提供文件下載選項。

4. 程式碼區塊強化 (PyMdown Extensions)

雖然這屬於 Markdown 擴充，但通常與 Material 主題搭配使用，能提供程式碼縮排、行號顯示與語法高亮。

• 設定範例：

  markdown_extensions:
    - pymdownx.highlight:
        anchor_linenums: true
    - pymdownx.inlinehilite
    - pymdownx.snippets
  

插件功能對照表

功能需求	推薦插件	建議安裝優先度
全文搜尋	search (內建)	必裝
圖片放大查看	mkdocs-medium-zoom	高
顯示修改日期	git-revision-date-localized	中
網頁標籤圖示	mkdocs-favicon	中
自動生成 PDF	pdf-export	低（視需求）

注意事項

1. 套件衝突：安裝過多插件可能會稍微減慢 mkdocs build 的速度。如果專案規模不大，建議只安裝真正需要的。
2. 依賴環境：部分插件（如 PDF 生成）可能需要額外的系統元件（例如 WeasyPrint），安裝前請務必查看該插件的 GitHub 說明文件。
3. 順序影響：在 mkdocs.yml 中，plugins 的排列順序有時會影響功能觸發，建議將 search 放在第一位。

掌握了插件的使用後，你的 MkDocs 網站已經具備了完整的互動能力。最後一章我們將學習 如何部署網站，讓你的筆記正式上線。