尧图网页设计 
Quartz RSS Feed 完整指南从index.xml生成到 ContentIndex 插件深度配置【免费下载链接】quartz a fast, batteries-included static-site generator that transforms Markdown content into fully functional websites项目地址: https://gitcode.com/GitHub_Trending/qua/quartzQuartz 会在构建站点时自动为全部内容生成一个符合 RSS 2.0 规范的订阅源默认输出为index.xml文件供各类 RSS 阅读器如 Reeder、NetNewsWire、Feedly 等订阅。本文将以 RSS Feed 功能文档 为核心骨架结合仓库中的源码、模板配置与插件文档带你掌握 RSS 的启用前提、baseUrl配置、ContentIndex 插件的全部自定义选项以及 RSS 在构建流水线中的真实生成机制。RSS Feed 的生成机制一句话理解Quartz 的 RSS 功能由ContentIndex 插件Emitter 类提供。在构建阶段该插件会遍历站点所有内容页面将它们汇总为一个 XML 文件默认文件名index.xml默认生成路径站点根目录功能归属ContentIndex 插件文档由于 RSS 规范要求每一条item必须包含绝对 URL而不是相对路径RSS 阅读器才能正确解析每篇内容的链接地址。因此baseUrl必须被正确设置这是 RSS 能被正常抓取和订阅的前提条件。[!info] 关键结论 部署后默认的 RSS 订阅地址为https://${baseUrl}/index.xml。也就是说如果你的baseUrl是example.com那么订阅链接就是https://example.com/index.xml。前置条件正确配置baseUrlbaseUrl是 RSS以及 sitemap、CNAME 文件能否正常工作的核心配置。在 cfg.ts 的源码注释中明确写道Base URL to use for CNAME files, sitemaps, and RSS feeds that require an absolute URL. Quartz will avoid using this as much as possible and use relative URLs most of the time即baseUrl专供需要绝对 URL 的产物CNAME、sitemap、RSS使用其余场景 Quartz 会尽量使用相对 URL以保证站点在任何部署位置都能正常工作。在quartz.config.yaml中配置configuration: pageTitle: My Site baseUrl: example.com # 部署后的域名不带协议、不带首尾斜杠配置时有几条硬性规则详见 configuration.md 的baseUrl一节规则示例不要带协议前缀写example.com而不是https://example.com不要带首尾斜杠写example.com而不是example.com/或/example.com/GitHub Pages 子路径场景需包含子路径仓库为jackyzha0/quartz时部署地址是https://jackyzha0.github.io/quartz则baseUrl应写jackyzha0.github.io/quartz通过 CLI 自动配置在初始化或交互式配置时CLI 会引导你设置baseUrl并自动帮你清理格式。在 handlers.js 的实现中可以看到它做了两件事baseUrl baseUrl.replace(/^https?:\/\//, ) // 剥离 http:// 或 https:// baseUrl baseUrl.replace(/\/$/, ) // 剥离末尾的斜杠这也是为什么你可以在创建站点时放心粘贴完整的带协议 URL最终写入配置的值会被自动规范化。模板中的默认值仓库内置的四个模板blog.yaml、default.yaml、obsidian.yaml、ttrpg.yaml默认baseUrl均为quartz.jzhao.xyz。部署到自己的域名后务必修改为实际地址否则 RSS 与 sitemap 中的链接会指向错误的域名。ContentIndex 插件RSS 的全部配置开关RSS 功能本质上是 ContentIndex 插件的一部分。该插件同时负责三件事见 ContentIndex 插件文档RSS 订阅源index.xml——本文主题XML Sitemapsitemap.xml——帮助搜索引擎发现站点页面contentIndex.json—— 供前端动态组件如全文搜索、关系图谱使用的结构化内容索引。因此修改 RSS 行为本质上就是配置这个插件。该插件在 quartz.config.yaml 中的声明方式为plugins: - source: quartz-community/content-index enabled: true options: enableSiteMap: true enableRSS: true以上即 blog.yaml 模板中的默认配置。完整配置参数表参数默认值说明enableSiteMaptrue是否生成sitemap.xml用于搜索引擎的内容发现enableRSStrue是否生成 RSS 订阅源index.xml包含近期内容更新rssLimit10RSS 中包含的最大条目数聚焦最新内容rssFullHtmlfalse若为trueRSS 每条目将包含页面的完整渲染 HTMLrssSlugindex生成的 RSS XML 文件的 slug 路径见下文includeEmptyFilestrue无正文内容body 为空的内容文件是否仍被纳入索引与产物自定义订阅地址rssSlug原 RSS Feed 文档 指出index.xml的路径可通过给 ContentIndex 插件传入rssSlug选项自定义。例如plugins: - source: quartz-community/content-index enabled: true options: enableRSS: true rssSlug: feed # 订阅地址变为 https://${baseUrl}/feed.xml设置后默认的https://${baseUrl}/index.xml就会变为https://${baseUrl}/feed.xml。控制条目数量与内容形态对于内容更新频繁的站点可以用rssLimit控制订阅源的体积options: enableRSS: true rssLimit: 20 # 只保留最近 20 篇内容 rssFullHtml: true # 每条目输出完整 HTML阅读器内可直接阅读全文rssFullHtml为false默认时订阅源仅包含摘要或描述为true时则内嵌整页渲染后的 HTML订阅体验更完整但文件体积会明显增大。安装未内置的插件如果当前站点配置中还没有 content-index 插件可以使用 CLI 安装并写入配置npx quartz plugin add github:quartz-community/content-index若克隆了已有配置的项目、需要批量补齐配置中引用的所有插件可运行npx quartz plugin install --from-config源码视角RSS 在构建流水线中的位置RSS 属于 Quartz 的Emitter发射器类别——它对全部处理后的内容做归约最终产出一个新文件。在 emit.ts 的构建流程中可以看到一个关键设计// Phase 2: Run all other emitters with content extended by virtual pages. // This ensures emitters like ContentIndex include virtual pages in their output // (e.g. sitemap, RSS, contentIndex.json used by the explorer sidebar). const contentWithVirtual ctx.virtualPages.length 0 ? [...content, ...ctx.virtualPages] : content这段代码意味着ContentIndex 生成的 RSS 与 sitemap 不只包含普通 Markdown 页面还包含 PageTypeDispatcher 生成的所有虚拟页面如标签聚合页、文件夹列表页、Bases 页面等。也就是说你的 RSS 订阅源天然覆盖整站所有可访问页面无需手动维护清单。对应的处理阶段发生在构建顺序的 Phase 2先由ComponentResources生成资源、由PageTypeDispatcher填充虚拟页面再让 ContentIndex 等发射器基于内容 虚拟页面的完整集合产出 RSS 与 sitemap。验证与故障排查部署完成后按以下步骤确认 RSS 是否正常工作确认baseUrl已修改检查 quartz.config.yaml 中configuration.baseUrl是否为最终部署域名不带协议。这是 RSS 链接错误的头号原因。检查生成文件构建产物public/目录下应存在index.xml或自定义的rssSlug对应文件。浏览器验证直接访问https://${baseUrl}/index.xml应返回合法的 XML 文档其中link与itemlink均指向正确的绝对地址。用阅读器测试将该 URL 粘贴到任意 RSS 阅读器进行订阅测试。如果页面使用了private、templates等被ignorePatterns忽略的目录这些内容不会出现在订阅源中——这与站内其他页面行为一致可参考 private pages 了解内容排除机制。总结RSS 由ContentIndex 插件在构建时生成默认输出index.xmlbaseUrl是硬性前提必须为最终部署域名不带协议、不带斜杠GitHub Pages 子路径场景需包含子路径通过rssSlug、rssLimit、rssFullHtml、includeEmptyFiles等选项可精细控制订阅源路径、条目数量与内容形态从源码看RSS 与 sitemap 还自动纳入了标签页、文件夹页等虚拟页面覆盖整站内容部署后订阅地址为https://${baseUrl}/index.xml或自定义 slug 对应的 XML 文件。【免费下载链接】quartz a fast, batteries-included static-site generator that transforms Markdown content into fully functional websites项目地址: https://gitcode.com/GitHub_Trending/qua/quartz创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 Quartz RSS Feed 完整指南：从 `index.xml` 生成到 ContentIndex 插件深度配置
Quartz RSS Feed 完整指南从index.xml生成到 ContentIndex 插件深度配置【免费下载链接】quartz a fast, batteries-included static-site generator that transforms Markdown content into fully functional websites项目地址: https://gitcode.com/GitHub_Trending/qua/quartzQuartz 会在构建站点时自动为全部内容生成一个符合 RSS 2.0 规范的订阅源默认输出为index.xml文件供各类 RSS 阅读器如 Reeder、NetNewsWire、Feedly 等订阅。本文将以 RSS Feed 功能文档 为核心骨架结合仓库中的源码、模板配置与插件文档带你掌握 RSS 的启用前提、baseUrl配置、ContentIndex 插件的全部自定义选项以及 RSS 在构建流水线中的真实生成机制。RSS Feed 的生成机制一句话理解Quartz 的 RSS 功能由ContentIndex 插件Emitter 类提供。在构建阶段该插件会遍历站点所有内容页面将它们汇总为一个 XML 文件默认文件名index.xml默认生成路径站点根目录功能归属ContentIndex 插件文档由于 RSS 规范要求每一条item必须包含绝对 URL而不是相对路径RSS 阅读器才能正确解析每篇内容的链接地址。因此baseUrl必须被正确设置这是 RSS 能被正常抓取和订阅的前提条件。[!info] 关键结论 部署后默认的 RSS 订阅地址为https://${baseUrl}/index.xml。也就是说如果你的baseUrl是example.com那么订阅链接就是https://example.com/index.xml。前置条件正确配置baseUrlbaseUrl是 RSS以及 sitemap、CNAME 文件能否正常工作的核心配置。在 cfg.ts 的源码注释中明确写道Base URL to use for CNAME files, sitemaps, and RSS feeds that require an absolute URL. Quartz will avoid using this as much as possible and use relative URLs most of the time即baseUrl专供需要绝对 URL 的产物CNAME、sitemap、RSS使用其余场景 Quartz 会尽量使用相对 URL以保证站点在任何部署位置都能正常工作。在quartz.config.yaml中配置configuration: pageTitle: My Site baseUrl: example.com # 部署后的域名不带协议、不带首尾斜杠配置时有几条硬性规则详见 configuration.md 的baseUrl一节规则示例不要带协议前缀写example.com而不是https://example.com不要带首尾斜杠写example.com而不是example.com/或/example.com/GitHub Pages 子路径场景需包含子路径仓库为jackyzha0/quartz时部署地址是https://jackyzha0.github.io/quartz则baseUrl应写jackyzha0.github.io/quartz通过 CLI 自动配置在初始化或交互式配置时CLI 会引导你设置baseUrl并自动帮你清理格式。在 handlers.js 的实现中可以看到它做了两件事baseUrl baseUrl.replace(/^https?:\/\//, ) // 剥离 http:// 或 https:// baseUrl baseUrl.replace(/\/$/, ) // 剥离末尾的斜杠这也是为什么你可以在创建站点时放心粘贴完整的带协议 URL最终写入配置的值会被自动规范化。模板中的默认值仓库内置的四个模板blog.yaml、default.yaml、obsidian.yaml、ttrpg.yaml默认baseUrl均为quartz.jzhao.xyz。部署到自己的域名后务必修改为实际地址否则 RSS 与 sitemap 中的链接会指向错误的域名。ContentIndex 插件RSS 的全部配置开关RSS 功能本质上是 ContentIndex 插件的一部分。该插件同时负责三件事见 ContentIndex 插件文档RSS 订阅源index.xml——本文主题XML Sitemapsitemap.xml——帮助搜索引擎发现站点页面contentIndex.json—— 供前端动态组件如全文搜索、关系图谱使用的结构化内容索引。因此修改 RSS 行为本质上就是配置这个插件。该插件在 quartz.config.yaml 中的声明方式为plugins: - source: quartz-community/content-index enabled: true options: enableSiteMap: true enableRSS: true以上即 blog.yaml 模板中的默认配置。完整配置参数表参数默认值说明enableSiteMaptrue是否生成sitemap.xml用于搜索引擎的内容发现enableRSStrue是否生成 RSS 订阅源index.xml包含近期内容更新rssLimit10RSS 中包含的最大条目数聚焦最新内容rssFullHtmlfalse若为trueRSS 每条目将包含页面的完整渲染 HTMLrssSlugindex生成的 RSS XML 文件的 slug 路径见下文includeEmptyFilestrue无正文内容body 为空的内容文件是否仍被纳入索引与产物自定义订阅地址rssSlug原 RSS Feed 文档 指出index.xml的路径可通过给 ContentIndex 插件传入rssSlug选项自定义。例如plugins: - source: quartz-community/content-index enabled: true options: enableRSS: true rssSlug: feed # 订阅地址变为 https://${baseUrl}/feed.xml设置后默认的https://${baseUrl}/index.xml就会变为https://${baseUrl}/feed.xml。控制条目数量与内容形态对于内容更新频繁的站点可以用rssLimit控制订阅源的体积options: enableRSS: true rssLimit: 20 # 只保留最近 20 篇内容 rssFullHtml: true # 每条目输出完整 HTML阅读器内可直接阅读全文rssFullHtml为false默认时订阅源仅包含摘要或描述为true时则内嵌整页渲染后的 HTML订阅体验更完整但文件体积会明显增大。安装未内置的插件如果当前站点配置中还没有 content-index 插件可以使用 CLI 安装并写入配置npx quartz plugin add github:quartz-community/content-index若克隆了已有配置的项目、需要批量补齐配置中引用的所有插件可运行npx quartz plugin install --from-config源码视角RSS 在构建流水线中的位置RSS 属于 Quartz 的Emitter发射器类别——它对全部处理后的内容做归约最终产出一个新文件。在 emit.ts 的构建流程中可以看到一个关键设计// Phase 2: Run all other emitters with content extended by virtual pages. // This ensures emitters like ContentIndex include virtual pages in their output // (e.g. sitemap, RSS, contentIndex.json used by the explorer sidebar). const contentWithVirtual ctx.virtualPages.length 0 ? [...content, ...ctx.virtualPages] : content这段代码意味着ContentIndex 生成的 RSS 与 sitemap 不只包含普通 Markdown 页面还包含 PageTypeDispatcher 生成的所有虚拟页面如标签聚合页、文件夹列表页、Bases 页面等。也就是说你的 RSS 订阅源天然覆盖整站所有可访问页面无需手动维护清单。对应的处理阶段发生在构建顺序的 Phase 2先由ComponentResources生成资源、由PageTypeDispatcher填充虚拟页面再让 ContentIndex 等发射器基于内容 虚拟页面的完整集合产出 RSS 与 sitemap。验证与故障排查部署完成后按以下步骤确认 RSS 是否正常工作确认baseUrl已修改检查 quartz.config.yaml 中configuration.baseUrl是否为最终部署域名不带协议。这是 RSS 链接错误的头号原因。检查生成文件构建产物public/目录下应存在index.xml或自定义的rssSlug对应文件。浏览器验证直接访问https://${baseUrl}/index.xml应返回合法的 XML 文档其中link与itemlink均指向正确的绝对地址。用阅读器测试将该 URL 粘贴到任意 RSS 阅读器进行订阅测试。如果页面使用了private、templates等被ignorePatterns忽略的目录这些内容不会出现在订阅源中——这与站内其他页面行为一致可参考 private pages 了解内容排除机制。总结RSS 由ContentIndex 插件在构建时生成默认输出index.xmlbaseUrl是硬性前提必须为最终部署域名不带协议、不带斜杠GitHub Pages 子路径场景需包含子路径通过rssSlug、rssLimit、rssFullHtml、includeEmptyFiles等选项可精细控制订阅源路径、条目数量与内容形态从源码看RSS 与 sitemap 还自动纳入了标签页、文件夹页等虚拟页面覆盖整站内容部署后订阅地址为https://${baseUrl}/index.xml或自定义 slug 对应的 XML 文件。【免费下载链接】quartz a fast, batteries-included static-site generator that transforms Markdown content into fully functional websites项目地址: https://gitcode.com/GitHub_Trending/qua/quartz创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考