MkDocs 初學者筆記

撰風要介紹一款非常好用的本地端系統－－MkDocs。身為一個筆記控，我個人習慣把資料寫成筆記，我用過許多筆記軟體，但總覺得使用起來不夠彈性，也無法自訂成自己喜歡的樣子，直到我發現 MkDocs，深得我心。

MkDocs 是以 Markdown 語法為基礎的靜態網站設計工具，通常用來撰寫文件、操作手冊、知識庫，然後再將結構化的資料轉成 HTML 靜態網站，完成後可以放在本地端自己查看，也可以上傳到網路上或GitHub Pages上供人查詢。所以對於公司內的重要文件，我覺得 MkDocs 可以表現得非常稱職，不用放到網路上也能讓同事查看資料。

第一次聽到Markdown語法的初學者請不用緊張，Markdown 語法是非常容易上手且直覺的語法，如果你有一些 Notion、Wordpress、HTML 等經驗，學習難度非常非常低，但就算沒有經驗，我這裡也會整理一些常用的語法，多寫幾次就會了。

MkDocs 簡介

MkDocs 是一個以Markdown為基礎的靜態網站產生器，專門設計來撰寫文件與筆記。它能將簡單的 Markdown 檔案轉換成結構化的網站，方便快速建立技術文件、操作手冊、知識庫、筆記本。

安裝方法

• 本文安裝將以 Visual Stuido Code 整合開發環境操作為例
• 安裝 Python 3.8 或以上的版本

自訂主題

• 內建多種佈景主題
• 可自訂 CSS / JavaScript 來改變版面設計
• 支援深色模式、配色調整

新增頁面

• 採用簡單的Markdown語法，專注於內容撰寫
• 支援標題、清單、表格、程式碼、數學公式

擴充功能

• pymdown-extensions：增強 Markdown 語法（提示框、標籤、程式碼高亮）
• MathJax / KaTeX：支援數學公式
• 插件（plugins）：例如全文搜尋、多語言支持

網站部署

• 使用 mkdocs build 生成 HTML 網站，輸出到 site/ 資料夾
• 不需伺服器或資料庫，任何地方都能打開
• 可放到任何靜態網站伺服器

相關網站

• MkDocs 官方 GitHub
• MkDocs 官方文件

相關文章

[PlayCanvas] Claude Desktop 的 Playcanvas Editor MCP Server 設定教學

[PlayCanvas + VIVERSE] 一次性 NPC 對話框

114年國中會考作文題「兩隻倉鼠」 足見出題者活在象牙塔的浪漫與無知

【木子李雲南米干】桃園米干推薦！紹子米干、豌豆粉、乾拌米干龍潭在地美食

免費可商用字型【貓啃什錦黑 (繁體中文版)】可愛活潑的馬克筆手繪風格字型

新手用 2 週打造 3D 密室逃脫遊戲！PlayCanvas × VIVERSE World × 爆肝實錄

網域商轉移！如何將網域從 GANDI 轉移至遠振？

2025新北微笑山線寶石任務

全台美食部落客、IG美食介紹、各大美食懶人包