RSS

通过为您的文档自动生成的 RSS 订阅源让用户保持更新

RSS 功能为您的文档提供了一个自动生成的 RSS 2.0 订阅源。用户可以订阅该订阅源,在发布新内容或修改现有页面时及时收到通知。

工作原理

Geistdocs 会自动生成一个包含以下内容的 RSS 订阅源:

  • 所有已发布的文档页面
  • 页面标题和描述
  • 每页的直接链接
  • 最后修改日期
  • 作者信息

订阅源会在每次请求时重新生成,确保订阅者始终收到有关文档的最新信息。

访问订阅源

RSS 订阅源可通过以下地址访问:

https://your-domain.com/rss.xml

用户可以使用以下方式订阅该 URL:

  • RSS 阅读器 (Feedly, Inoreader, NewsBlur)
  • 电子邮件服务 (Blogtrottr, Kill the Newsletter)
  • 浏览器扩展
  • 新闻聚合器

RSS 按钮

导航栏中会显示一个便捷的 RSS 按钮,方便用户发现并订阅您的订阅源。单击该按钮会在新标签页中打开 RSS XML。

订阅源格式

该 RSS 订阅源遵循 RSS 2.0 规范,并包含以下内容:

频道元数据

<channel>
  <title>Your Documentation Title</title>
  <link>https://your-domain.com</link>
  <language>en</language>
  <image>https://your-domain.com/banner.png</image>
  <copyright>All rights reserved [Year], [Your Organization]</copyright>
</channel>

条目格式

每个文档页面都会作为一个条目出现:

<item>
  <guid>page-url</guid>
  <title>Page Title</title>
  <description>Page description</description>
  <link>https://your-domain.com/docs/page-url</link>
  <pubDate>Thu, 12 Nov 2025 00:00:00 GMT</pubDate>
  <author>
    <name>Your Organization</name>
  </author>
</item>

配置

RSS 订阅源要求设置 NEXT_PUBLIC_VERCEL_PROJECT_PRODUCTION_URL 环境变量,您可以在 环境变量 一节中阅读更多信息。

它还需要在 Geistdocs 配置文件中导出一个 title,您可以在 配置 一节中阅读更多信息。

功能

自动更新

订阅源会自动包含:

  • 新创建的页面
  • 已更新的页面内容(使用最后修改日期)
  • 更改的标题或描述
  • 来自您的文档源的所有页面

最后修改日期

页面使用它们的 lastModified frontmatter 字段,或回退到当前日期:

content/docs/example.mdx
---
title: Example Page
description: An example documentation page
lastModified: 2025-11-12
---