@rspress/plugin-rss 2.0.0-rc.5 → 2.0.0-rc.6

package/dist/index.d.ts

@@ -72,9 +72,10 @@ export declare type FeedOutputType = /** Atom 1.0 Feed */ 'atom' | /** RSS 2.0 F
 /**
  * @public
  * @param page Rspress Page Data
- * @param siteUrl
+ * @param siteUrl Site URL for generating absolute links
+ * @param htmlContent HTML content extracted from SSG output (optional)
  */
-export declare function generateFeedItem(page: PageIndexInfo, siteUrl: string): {
+export declare function generateFeedItem(page: PageIndexInfo, siteUrl: string, htmlContent?: string | null): {
     id: string;
     title: string;
     author: Author[] | undefined;

package/dist/index.js

@@ -34,7 +34,26 @@ async function writeFile(path, content) {
     });
     return promises.writeFile(path, content);
 }
-function generateFeedItem(page, siteUrl) {
+async function readFile(path) {
+    try {
+        return await promises.readFile(path, 'utf-8');
+    } catch  {
+        return null;
+    }
+}
+function routePathToHtmlPath(routePath) {
+    let fileName = routePath;
+    fileName = fileName.endsWith('/') ? `${routePath}index.html` : `${routePath}.html`;
+    return fileName.replace(/^\/+/, '');
+}
+function extractHtmlContent(html) {
+    const match = html.match(/<div[^>]*class="[^"]*rspress-doc[^"]*"[^>]*>([\s\S]*?)<\/div>(?=<footer|<\/main)/);
+    if (match) return match[1].trim();
+    const fallbackMatch = html.match(/<div[^>]*class="[^"]*rspress-doc[^"]*"[^>]*>([\s\S]*?)<\/div>/);
+    if (fallbackMatch) return fallbackMatch[1].trim();
+    return null;
+}
+function generateFeedItem(page, siteUrl, htmlContent) {
     const { frontmatter: fm } = page;
     return {
         id: selectNonNullishProperty(fm.slug, fm.id, page.routePath) || '',
@@ -42,7 +61,7 @@ function generateFeedItem(page, siteUrl) {
         author: toAuthors(fm.author),
         link: resolve(siteUrl, selectNonNullishProperty(fm.permalink, page.routePath)?.replace(/^\//, '') || ''),
         description: selectNonNullishProperty(fm.description) || '',
-        content: selectNonNullishProperty(fm.summary, page._html) || '',
+        content: selectNonNullishProperty(fm.summary, htmlContent, page.content) || '',
         date: toDate(fm.date || fm.published_at),
         category: concatArray(fm.categories, fm.category).map((cat)=>({
                 name: cat
@@ -173,10 +192,10 @@ class FeedsSet {
         return this.feeds.slice(0);
     }
 }
-function getRssItems(feeds, page, siteUrl) {
+async function getRssItems(feeds, page, siteUrl, htmlContent) {
     return Promise.all(feeds.filter((options)=>testPage(options.test, page)).map(async (options)=>{
         const after = options.item || ((feed)=>feed);
-        const item = await after(generateFeedItem(page, siteUrl), page);
+        const item = await after(generateFeedItem(page, siteUrl, htmlContent), page);
         return {
             ...item,
             channel: options.id
@@ -185,48 +204,61 @@ function getRssItems(feeds, page, siteUrl) {
 }
 function pluginRss(pluginRssOptions) {
     const feedsSet = new FeedsSet();
-    let _rssWorkaround = null;
+    let _pagesForRss = null;
     return {
         name: PluginName,
         globalUIComponents: Object.values(PluginComponents),
         beforeBuild (config, isProd) {
             if (!isProd) {
-                _rssWorkaround = null;
+                _pagesForRss = null;
                 return;
             }
-            _rssWorkaround = {};
+            const enableSSG = Boolean((config.ssg || config.llms) ?? true);
+            if (!enableSSG) throw new Error("[plugin-rss] RSS plugin requires SSG to be enabled. Please set `ssg: true` in your rspress.config.ts or remove the RSS plugin.");
+            _pagesForRss = new Map();
             feedsSet.set(pluginRssOptions, config);
         },
         async extendPageData (pageData) {
-            if (!_rssWorkaround) return;
-            _rssWorkaround[pageData.routePath] = _rssWorkaround[pageData.routePath] || getRssItems(feedsSet.get(), pageData, pluginRssOptions.siteUrl);
-            const feeds = await _rssWorkaround[pageData.routePath];
+            if (!_pagesForRss) return;
+            const matchedChannels = feedsSet.get().filter((options)=>testPage(options.test, pageData)).map((options)=>options.id);
+            if (matchedChannels.length > 0) _pagesForRss.set(pageData.routePath, {
+                page: pageData,
+                channels: matchedChannels
+            });
             const showRssList = new Set(concatArray(pageData.frontmatter['link-rss']));
-            for (const feed of feeds)showRssList.add(feed.channel);
+            for (const channel of matchedChannels)showRssList.add(channel);
             pageData.feeds = Array.from(showRssList, (id)=>{
-                const { output, language } = feedsSet.get(id);
+                const feedChannel = feedsSet.get(id);
+                if (!feedChannel) return null;
+                const { output, language } = feedChannel;
                 return {
                     url: output.url,
                     mime: output.mime,
                     language: language || pageData.lang
                 };
-            });
+            }).filter(Boolean);
         },
         async afterBuild (config) {
-            if (!_rssWorkaround) return;
-            const items = concatArray(...await Promise.all(Object.values(_rssWorkaround)));
+            if (!_pagesForRss) return;
+            const outDir = config.outDir || 'doc_build';
             const feeds = Object.create(null);
-            for (const { channel, ...item } of items){
-                feeds[channel] = feeds[channel] || new Feed(createFeed(feedsSet.get(channel), config));
-                feeds[channel].addItem(item);
+            for (const [routePath, { page, channels }] of _pagesForRss){
+                const htmlPath = node_path.resolve(outDir, routePathToHtmlPath(routePath));
+                const htmlFile = await readFile(htmlPath);
+                const htmlContent = htmlFile ? extractHtmlContent(htmlFile) : null;
+                const items = await getRssItems(channels.map((id)=>feedsSet.get(id)), page, pluginRssOptions.siteUrl, htmlContent);
+                for (const { channel, ...item } of items){
+                    feeds[channel] = feeds[channel] || new Feed(createFeed(feedsSet.get(channel), config));
+                    feeds[channel].addItem(item);
+                }
             }
             for (const [channel, feed] of Object.entries(feeds)){
                 const { output } = feedsSet.get(channel);
                 feed.items.sort(output.sorting);
-                const path = node_path.resolve(config.outDir || 'doc_build', output.dir, output.filename);
+                const path = node_path.resolve(outDir, output.dir, output.filename);
                 await writeFile(path, output.getContent(feed));
             }
-            _rssWorkaround = null;
+            _pagesForRss = null;
         }
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/plugin-rss",
-  "version": "2.0.0-rc.5",
+  "version": "2.0.0-rc.6",
   "description": "A plugin for rss generation for rspress",
   "bugs": "https://github.com/web-infra-dev/rspress/issues",
   "repository": {
@@ -28,15 +28,15 @@
     "feed": "^4.2.2"
   },
   "devDependencies": {
-    "@rslib/core": "0.19.1",
+    "@rslib/core": "0.19.2",
     "@types/node": "^22.8.1",
-    "@types/react": "^19.2.7",
+    "@types/react": "^19.2.8",
     "react": "^19.2.3",
     "rsbuild-plugin-publint": "^0.3.3",
     "typescript": "^5.8.2"
   },
   "peerDependencies": {
-    "@rspress/core": "^2.0.0-rc.5"
+    "@rspress/core": "^2.0.0-rc.6"
   },
   "engines": {
     "node": ">=20.9.0"