Skip to content

基本操作指令

MkDocs是靜態網站產生工具，他可以將我們寫好的markdown文件迅速地轉換成一個網站。

🔧 安裝

如果只是單純要使用mkdocs。

pip install mkdocs

如果是直接安裝mkdocs-material，裡面就已經包含mkdocs了。

pip install mkdocs-material

🖥️ 基本使用說明

📌 建立新的專案

如果要使用當下目錄作為專案目錄：

# 在當下的目錄建立新專案
mkdocs new .

如果要建立新的目錄：

# 建立一個新專案，並將專案的資料夾命名為projectname
mkdocs new projectname

📌 啟動伺服器來檢視網站

mkdocs serve

📌 建立網站

指令:

mkdocs build

mkdocs build --clean

說明:

1️⃣ mkdocs build

  • 讀取 mkdocs.yml 配置
  • 解析 docs/ 目錄下的 Markdown 文件
  • 產生 靜態 HTML 檔案
  • 輸出到 site/ 目錄

2️⃣ mkdocs build --clean

  • 刪除舊的 site/ 目錄（確保沒有舊的檔案殘留）
  • 避免過時的 HTML 檔案影響新版本

📌 佈署到github pages

mkdocs gh-deploy

📖 參考資料