RSS 插件配置¶

为你的 Zensical 网站添加 RSS 订阅功能

功能状态

RSS 功能目前正在 Zensical 的 Feature Parity 阶段开发中。以下配置基于 Material for MkDocs 的实现，Zensical 的具体配置可能有所不同，请以官方文档为准。

什么是 RSS？¶

RSS (Really Simple Syndication) 是一种网站内容聚合格式，允许用户订阅网站更新：

✅ 自动通知 - 用户无需手动检查更新
✅ 内容聚合 - 在 RSS 阅读器中统一查看
✅ 标准格式 - 被各种阅读器广泛支持

基本配置¶

在 zensical.toml 中启用 RSS 插件：

[project.plugins.rss]

配置选项¶

完整配置示例¶

[project.plugins.rss]
# 启用/禁用
enabled = true

# Feed 设置
feed_ttl = 1440              # 缓存时间（分钟）
date_from_meta = true        # 从 front matter 获取日期

# 内容设置
abstract_chars_count = 160   # 摘要字符数
abstract_delimiter = "<!-- more -->"  # 摘要分隔符

# 图片设置
image = "assets/logo.png"    # Feed 图标

# 分类设置
categories = ["categories", "tags"]  # 分类来源

# URL 设置
url_parameters = ""          # URL 参数

配置说明¶

选项	类型	默认值	说明
`enabled`	布尔值	`true`	是否启用 RSS
`feed_ttl`	整数	`1440`	Feed 缓存时间（分钟）
`abstract_chars_count`	整数	`160`	摘要字符数
`image`	字符串	-	Feed 图标路径
`date_from_meta`	布尔值	`true`	从 front matter 获取日期

使用方法¶

在文章中设置日期¶

确保每篇文章都有日期信息：

---
title: 我的文章
date: 2025-01-22
---

设置摘要¶

使用分隔符标记摘要结束位置：

---
title: 我的文章
date: 2025-01-22
---

这是文章摘要，会显示在 RSS Feed 中。

<!-- more -->

这部分内容不会出现在摘要中。

访问 RSS Feed¶

RSS Feed 通常位于以下地址：

主 Feed: https://your-site.com/feed_rss_created.xml
更新 Feed: https://your-site.com/feed_rss_updated.xml

添加 RSS 链接¶

在页面中添加 RSS 订阅链接：

<a href="/feed_rss_created.xml">
    <span class="twemoji">📰</span> RSS 订阅
</a>

或在导航中添加：

nav = [
    # ... 其他导航项
    { "RSS 订阅" = "feed_rss_created.xml" },
]

常见问题¶

RSS Feed 不更新¶

问题：发布新文章后 RSS 不更新

解决方案：

确保文章有正确的 date 字段
重新构建网站：zensical build --clean
检查 Feed 缓存设置

摘要显示不正确¶

问题：摘要内容过长或过短