跳轉到

網站主題推薦

選對主題可以讓你的筆記從「純文字檔案」瞬間升級為「專業技術文件」。MkDocs 的主題生態系非常成熟,以下是目前主流的選擇評測。

MkDocs 主題列表

主題 安裝 配置
Bootstrap (預設)
Material for MkDocs (推薦)
ReadTheDocs-Dropdown (說明書)
Windmill
Windmill Dark
docSkimmer
Cluster
Cinder
CustomMill
Bootswatch
Bootstrap386
PSinder
Bootstrap4
GitBook Theme
Ivory Theme
Lantana
Simple Blog
Terminal for MkDocs
Dracula Theme

Material for MkDocs:這是目前 MkDocs 社群公認的標竿主題,不僅視覺現代化,還內建了許多實用功能。

MkDocs-Themes

如何安裝與啟用

以安裝 Material for MkDocs 為例

  1. 安裝:在終端機中輸入

    pip install mkdocs-material
    
  2. 配置:接著在 mkdocs.yml 中修改設定:

    theme:
    name: material
    
  3. 配色:你可以透過簡單的 YAML 語法調整配色與功能

    theme:
    name: material
    language: zh-Hant      # 設定為繁體中文介面
    palette:
        - media: "(prefers-color-scheme: light)"
        scheme: default
        primary: indigo    # 主色調
        accent: indigo     # 強調色
        toggle:
            icon: material/weather-sunny
            name: 切換至深色模式
        - media: "(prefers-color-scheme: dark)"
        scheme: slate
        primary: indigo
        accent: indigo
        toggle:
            icon: material/weather-night
            name: 切換至淺色模式
    features:
        - navigation.tabs    # 將選單改為頂部頁籤
        - navigation.top     # 顯示「回到頂部」按鈕
        - search.suggest     # 搜尋時自動顯示建議內容
        - search.highlight   # 高亮搜尋關鍵字
    

主題挑選建議

  1. 適應性:Material 主題在手機與平板上的選單收納做得非常好,這對於通勤時閱讀筆記非常重要。
  2. 穩定度:建議選擇 indigo (靛藍) 或 teal (藍綠) 等對眼睛負擔較小的顏色。
  3. 擴充性:Material 主題支援非常多額外的 Plugin(如圖表、數學公式),如果你未來有進階需求,選它能省下很多換主題的麻煩。