Skip to content

MkDocs & Material for MkDocs 簡介

🔹 MkDocs 是什麼?

MkDocs 是一個 靜態網站生成器,專門用來 建立技術文件網站,它使用 Markdown 編寫內容,然後轉換成 HTML 靜態網站

📌 特點

  • 用 Markdown 撰寫(簡單、直觀)
  • 速度快(生成靜態 HTML,沒有伺服器負擔)
  • 適合技術文件(API 文件、教學、知識庫)
  • 可部署在 GitHub Pages、Netlify、Vercel

🔹 Material for MkDocs 是什麼?

Material for MkDocsMkDocs 的最佳佈景主題,提供 現代 UI,並支援 搜尋、導航、側邊欄、Admonitions(提示框)、Tabs(標籤頁)等進階功能

📌 Material for MkDocs 提供的功能

  • 漂亮的 UI(基於 Google Material Design)
  • 強大搜尋(內建全文搜尋)
  • 支援 Admonition(提示框)、標籤頁、程式碼高亮
  • 適合知識庫、API 文檔、教學網站
  • 高度客製化(CSS + JS)

📌 MkDocs vs Material for MkDocs 有什麼差別?

比較項目 MkDocs Material for MkDocs
用途 產生技術文件網站 MkDocs 的佈景主題
UI / 設計 基本的 Bootstrap 風格 Material Design(更現代化)
內建功能 只有基本 Markdown 轉 HTML 支援 Tabs、Admonition、全文搜尋等
適合誰? 只需要基本文件網站 想要更專業、更漂亮的文件站

簡單來說

  • MkDocsMarkdown → HTML 的靜態網站生成工具。
  • Material for MkDocs讓 MkDocs 更漂亮、更好用的佈景主題

📌 Material for MkDocs vs 其他常見工具

比較項目 Material for MkDocs Blogger Google Sites WordPress
主要用途 技術文件、知識庫 部落格、文章 公司內部網頁、簡單網站 部落格、企業網站
內容格式 Markdown WYSIWYG / HTML WYSIWYG WYSIWYG / HTML
SEO 友善 ✅ 需要手動設定 ✅ 內建 ❌ 不適合 SEO ✅ 內建強大 SEO
外觀客製化 ✅ 可自訂 CSS / JS ❌ 內建主題有限 ❌ 幾乎無法客製化 ✅ 支援多種佈景主題
是否支援 AdSense ❌ 不支援 ✅ 內建支援 ❌ 無法掛廣告 ✅ 內建支援
是否支援程式碼高亮 ✅ 內建 ❌ 需額外設定 ❌ 不支援 ⚠️ 需要外掛
適合技術文件 非常適合 ❌ 不適合 ❌ 不適合 ⚠️ 可用,但不是最佳選擇
適合商業部落格 ❌ 不是主要用途 ✅ 適合 ❌ 不適合 ✅ 適合
部署方式 GitHub Pages / Netlify / Vercel Google 託管 Google 託管 自行選擇伺服器
維護成本 最低 最低 中等(需管理伺服器)

📌 優缺點分析

⭕ Material for MkDocs 優點

  1. 適合技術文件:特別適合 API 文件、教學、知識庫
  2. Markdown 撰寫:比 Blogger / WordPress 更簡單直觀。
  3. 靜態網站,載入超快:不需要後端,部署在 GitHub Pages 或 Netlify 完全免費
  4. 支援全文搜尋:內建搜尋功能,方便讀者查找內容。
  5. 高度可客製化:可以修改 CSS、JS,甚至擴展功能。

❌ Material for MkDocs 缺點

  1. 不適合商業部落格無法掛 Google AdSense,不適合用來賺廣告收入。
  2. 需要 Git / Markdown 基礎:不像 Blogger/WordPress 可以直接編輯,需要學習 Git + Markdown。
  3. 不適合動態內容:不支援留言、用戶登入、後台管理等功能(但可以用 GitHub Issue 替代留言)。

📌 什麼情況應該選 Material for MkDocs?

適合使用 Material for MkDocs 的情境

  • 你需要 技術文件網站、API 文件、知識庫(如:程式教學、日文學習指南)
  • 你習慣使用 Markdown
  • 你不需要 AdSense 或商業化功能
  • 你希望 部署在 GitHub Pages / Netlify(免費)

不適合 Material for MkDocs 的情境

  • 你想要寫 部落格 + 掛 Google AdSense選 Blogger / WordPress
  • 你希望 不寫程式就能管理網站選 Google Sites
  • 你需要 支援使用者留言、會員功能選 WordPress

📝 結論

你需要 最佳選擇
技術文件 / API 文件 / 知識庫 Material for MkDocs
一般部落格 Blogger / WordPress
簡單企業網站 / 內部網站 Google Sites
自訂網站 + 商業用途 WordPress / 自架網站

📌 如果你的需求是技術文件,Material for MkDocs 是最好的選擇!
📌 如果你只是寫部落格,Blogger 或 WordPress 會更適合!