Skip to content

RSS設定

MkDocs Material 支援 RSS(Really Simple Syndication),讓使用者可以訂閱你的部落格更新。你可以透過 RSS 插件 來啟用這個功能。


🔹 1. 安裝 mkdocs-rss-plugin

首先,安裝 RSS 插件

pip install mkdocs-rss-plugin


🔹 2. 在 mkdocs.yml 啟用 RSS

編輯 mkdocs.yml,加入以下內容:

plugins:
  - search
  - blog  # 確保 Blog 已啟用
  - rss:
      match_path: "blog/.*"  # 指定部落格路徑
      date_from_meta: date
      categories_from_meta: tags

📌 **說明**
  • match_path: "blog/.*" → 只包含 blog/ 目錄下的文章到 RSS。
  • date_from_meta: date → 讓 RSS 使用 Markdown 內的 date 作為發佈日期。
  • categories_from_meta: tags → 讓 RSS 讀取 tags 作為分類標籤。

🔹 3. 在文章上加入日期

為了讓 RSS 正確運作,每篇 Blog 文章 需要有 日期資訊

---
title: "我的第一篇 Blog"
date: 2024-02-11
tags:
  - Python
  - MkDocs
---
這是一篇示範文章,測試 RSS 功能。
📌 這樣 RSS 會讀取 date 作為發佈時間,並將 tags 設為分類!


🔹 4. 生成 RSS

執行:

mkdocs build
RSS Feed 會自動生成在:
site/rss.xml
你可以在 https://yourwebsite.com/blog/feed_rss_created.xmlhttp://yourwebsite.com/rss.xml 存取 RSS Feed!


✅ 總結

步驟 指令 / 設定 說明
安裝 RSS 插件 pip install mkdocs-rss-plugin 讓 MkDocs 支援 RSS
設定 mkdocs.yml plugins: - rss 啟用 RSS 功能
確保文章有 date date: YYYY-MM-DD 讓 RSS 知道文章發佈時間
生成 RSS mkdocs build 生成 rss.xml

這樣你的 MkDocs Material 網站 就有 RSS Feed 了!🚀🔥