Skip to content

部落格(Blog)設定

🔹 1. 安裝必要套件

如果你已經安裝 Material for MkDocs，可以跳過這一步。

pip install mkdocs-material

🔹 2. 修改 mkdocs.yml 設定

在 mkdocs.yml 中加入以下設定：

plugins:
  - search
  - blog

🔹 3. 建立 Blog 文章

預設的 blog 文章結構如下：

.
├─ docs/
│  └─ blog/
│     ├─ posts/
│     │  └─ hello-world.md 
│     └─ index.md
└─ mkdocs.yml

不同的設定，目錄的架構會不太一樣。

plugins:
  - search
  - blog:
      blog_dir: .           # 指定 Blog 文章存放的目錄

docs/
├── index.md
├── about.md
├── posts/
│   ├── 2024-02-11-my-first-post.md
│   ├── 2024-02-12-second-post.md

📌 Markdown 文章格式

在每篇 Markdown 文章開頭加上 YAML Front Matter：

---
title: "我的第一篇 Blog"
date: 2024-02-11
categories:
  - 技術
tags:
  - Python
  - MkDocs
---

這是我的第一篇 Blog 文章，使用 MkDocs Material 來建立！

🔹 4. 啟動本地測試

執行以下指令來啟動本地伺服器：

mkdocs serve
然後打開 http://127.0.0.1:8000/blog/，你應該能夠看到 Blog 文章！

📝 總結

步驟 說明
安裝 Material for MkDocs pip install mkdocs-material
修改 mkdocs.yml 啟用 blog 插件
建立 docs/blog/ 目錄 在 docs/blog/ 內新增 Blog 文章
新增 Blog 文章 加入 YAML Front Matter
啟動 MkDocs 本地伺服器 mkdocs serve

📖 參考資料