@docusaurus/plugin-content-blog 3.0.0-alpha.0 → 3.0.0-rc.0

package/.docusaurus/routesChunkNames.json

@@ -0,0 +1,194 @@
+{
+  "/blog-only/2018/12/14/Happy-First-Birthday-Slash-b2d": {
+    "__comp": "ccc49370",
+    "__context": {
+      "plugin": "1a450a71"
+    },
+    "sidebar": "814f3328",
+    "content": "d1e647af"
+  },
+  "/blog-only/archive-111": {
+    "__comp": "9e4087bc",
+    "__context": {
+      "plugin": "1a450a71"
+    },
+    "archive": "8941cadf"
+  },
+  "/blog-only/blog-with-links-b8a": {
+    "__comp": "ccc49370",
+    "__context": {
+      "plugin": "1a450a71"
+    },
+    "sidebar": "814f3328",
+    "content": "fe567c9f"
+  },
+  "/blog-only/date-matter-e95": {
+    "__comp": "ccc49370",
+    "__context": {
+      "plugin": "1a450a71"
+    },
+    "sidebar": "814f3328",
+    "content": "1910f98c"
+  },
+  "/blog-only/heading-as-title-01d": {
+    "__comp": "ccc49370",
+    "__context": {
+      "plugin": "1a450a71"
+    },
+    "sidebar": "814f3328",
+    "content": "10c8a0c7"
+  },
+  "/blog-only/hey/my super path/héllô-71d": {
+    "__comp": "ccc49370",
+    "__context": {
+      "plugin": "1a450a71"
+    },
+    "sidebar": "814f3328",
+    "content": "31456d57"
+  },
+  "/blog-only/mdx-blog-post-72e": {
+    "__comp": "ccc49370",
+    "__context": {
+      "plugin": "1a450a71"
+    },
+    "sidebar": "814f3328",
+    "content": "025bf2bf"
+  },
+  "/blog-only/mdx-require-blog-post-d01": {
+    "__comp": "ccc49370",
+    "__context": {
+      "plugin": "1a450a71"
+    },
+    "sidebar": "814f3328",
+    "content": "4baa0397"
+  },
+  "/blog-only/page/2-0a4": {
+    "__comp": "a6aa9e1f",
+    "__context": {
+      "plugin": "1a450a71"
+    },
+    "sidebar": "814f3328",
+    "items": [
+      {
+        "content": "8f113c1e"
+      },
+      {
+        "content": "2d0e482b"
+      },
+      {
+        "content": "fa937875"
+      }
+    ],
+    "metadata": "3401dd63"
+  },
+  "/blog-only/page/3-070": {
+    "__comp": "a6aa9e1f",
+    "__context": {
+      "plugin": "1a450a71"
+    },
+    "sidebar": "814f3328",
+    "items": [
+      {
+        "content": "7050df0f"
+      },
+      {
+        "content": "69ddce25"
+      }
+    ],
+    "metadata": "84412660"
+  },
+  "/blog-only/search-043": {
+    "__comp": "1a4e3797",
+    "__context": {
+      "plugin": "90fdef38"
+    }
+  },
+  "/blog-only/simple/slug-ff5": {
+    "__comp": "ccc49370",
+    "__context": {
+      "plugin": "1a450a71"
+    },
+    "sidebar": "814f3328",
+    "content": "324f81e8"
+  },
+  "/blog-only/tags-821": {
+    "__comp": "01a85c17",
+    "__context": {
+      "plugin": "1a450a71"
+    },
+    "sidebar": "814f3328",
+    "tags": "6fa419d5"
+  },
+  "/blog-only/tags/birthday-8e4": {
+    "__comp": "6875c492",
+    "__context": {
+      "plugin": "1a450a71"
+    },
+    "sidebar": "814f3328",
+    "items": [
+      {
+        "content": "69ddce25"
+      }
+    ],
+    "tag": "0cc99ed5",
+    "listMetadata": "44bf5914"
+  },
+  "/blog-only/tags/complex-f0f": {
+    "__comp": "6875c492",
+    "__context": {
+      "plugin": "1a450a71"
+    },
+    "sidebar": "814f3328",
+    "items": [
+      {
+        "content": "8f113c1e"
+      }
+    ],
+    "tag": "1b99ff01",
+    "listMetadata": "b5733902"
+  },
+  "/blog-only/tags/date-b36": {
+    "__comp": "6875c492",
+    "__context": {
+      "plugin": "1a450a71"
+    },
+    "sidebar": "814f3328",
+    "items": [
+      {
+        "content": "8f113c1e"
+      },
+      {
+        "content": "7050df0f"
+      }
+    ],
+    "tag": "59ce4a4b",
+    "listMetadata": "447a0fe3"
+  },
+  "/blog-only/unlisted-8d8": {
+    "__comp": "ccc49370",
+    "__context": {
+      "plugin": "1a450a71"
+    },
+    "sidebar": "814f3328",
+    "content": "5cb65b8e"
+  },
+  "/blog-only/-813": {
+    "__comp": "a6aa9e1f",
+    "__context": {
+      "plugin": "1a450a71"
+    },
+    "sidebar": "814f3328",
+    "items": [
+      {
+        "content": "6dea708c"
+      },
+      {
+        "content": "5bd9aa47"
+      },
+      {
+        "content": "3cdbedcf"
+      }
+    ],
+    "metadata": "163f190c"
+  }
+}

package/.docusaurus/site-metadata.json

@@ -0,0 +1,24 @@
+{
+  "docusaurusVersion": "3.0.0-alpha.0",
+  "siteVersion": "3.0.0-alpha.0",
+  "pluginVersions": {
+    "docusaurus-plugin-content-blog": {
+      "type": "project"
+    },
+    "docusaurus-plugin-sitemap": {
+      "type": "package",
+      "name": "@docusaurus/plugin-sitemap",
+      "version": "3.0.0-alpha.0"
+    },
+    "docusaurus-theme-classic": {
+      "type": "package",
+      "name": "@docusaurus/theme-classic",
+      "version": "3.0.0-alpha.0"
+    },
+    "docusaurus-theme-search-algolia": {
+      "type": "package",
+      "name": "@docusaurus/theme-search-algolia",
+      "version": "3.0.0-alpha.0"
+    }
+  }
+}

package/lib/feed.js

@@ -12,6 +12,7 @@ const path_1 = tslib_1.__importDefault(require("path"));
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const feed_1 = require("feed");
+const srcset = tslib_1.__importStar(require("srcset"));
 const utils_1 = require("@docusaurus/utils");
 const utils_common_1 = require("@docusaurus/utils-common");
 const cheerio_1 = require("cheerio");
@@ -22,7 +23,10 @@ async function generateBlogFeed({ blogPosts, options, siteConfig, outDir, locale
     const { feedOptions, routeBasePath } = options;
     const { url: siteUrl, baseUrl, title, favicon } = siteConfig;
     const blogBaseUrl = (0, utils_1.normalizeUrl)([siteUrl, baseUrl, routeBasePath]);
-    const updated = blogPosts[0]?.metadata.date;
+    const blogPostsForFeed = feedOptions.limit === false || feedOptions.limit === null
+        ? blogPosts
+        : blogPosts.slice(0, feedOptions.limit);
+    const updated = blogPostsForFeed[0]?.metadata.date;
     const feed = new feed_1.Feed({
         id: blogBaseUrl,
         title: feedOptions.title ?? `${title} Blog`,
@@ -35,7 +39,7 @@ async function generateBlogFeed({ blogPosts, options, siteConfig, outDir, locale
     });
     const createFeedItems = options.feedOptions.createFeedItems ?? defaultCreateFeedItems;
     const feedItems = await createFeedItems({
-        blogPosts,
+        blogPosts: blogPostsForFeed,
         siteConfig,
         outDir,
         defaultCreateFeedItems,
@@ -52,11 +56,34 @@ async function defaultCreateFeedItems({ blogPosts, siteConfig, outDir, }) {
         const { metadata: { title: metadataTitle, permalink, date, description, authors, tags, }, } = post;
         const content = await (0, utils_1.readOutputHTMLFile)(permalink.replace(siteConfig.baseUrl, ''), outDir, siteConfig.trailingSlash);
         const $ = (0, cheerio_1.load)(content);
-        const link = (0, utils_1.normalizeUrl)([siteUrl, permalink]);
+        const blogPostAbsoluteUrl = (0, utils_1.normalizeUrl)([siteUrl, permalink]);
+        const toAbsoluteUrl = (src) => String(new URL(src, blogPostAbsoluteUrl));
+        // Make links and image urls absolute
+        // See https://github.com/facebook/docusaurus/issues/9136
+        $(`div#${utils_common_1.blogPostContainerID} a, div#${utils_common_1.blogPostContainerID} img`).each((_, elm) => {
+            if (elm.tagName === 'a') {
+                const { href } = elm.attribs;
+                if (href) {
+                    elm.attribs.href = toAbsoluteUrl(href);
+                }
+            }
+            else if (elm.tagName === 'img') {
+                const { src, srcset: srcsetAttr } = elm.attribs;
+                if (src) {
+                    elm.attribs.src = toAbsoluteUrl(src);
+                }
+                if (srcsetAttr) {
+                    elm.attribs.srcset = srcset.stringify(srcset.parse(srcsetAttr).map((props) => ({
+                        ...props,
+                        url: toAbsoluteUrl(props.url),
+                    })));
+                }
+            }
+        });
         const feedItem = {
             title: metadataTitle,
-            id: link,
-            link,
+            id: blogPostAbsoluteUrl,
+            link: blogPostAbsoluteUrl,
             date,
             description,
             // Atom feed demands the "term", while other feeds use "name"

package/lib/options.js

@@ -10,7 +10,7 @@ exports.validateOptions = exports.DEFAULT_OPTIONS = void 0;
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const utils_1 = require("@docusaurus/utils");
 exports.DEFAULT_OPTIONS = {
-    feedOptions: { type: ['rss', 'atom'], copyright: '' },
+    feedOptions: { type: ['rss', 'atom'], copyright: '', limit: 20 },
     beforeDefaultRehypePlugins: [],
     beforeDefaultRemarkPlugins: [],
     admonitions: true,
@@ -92,6 +92,9 @@ const PluginOptionSchema = utils_validation_1.Joi.object({
         }),
         language: utils_validation_1.Joi.string(),
         createFeedItems: utils_validation_1.Joi.function(),
+        limit: utils_validation_1.Joi.alternatives()
+            .try(utils_validation_1.Joi.number(), utils_validation_1.Joi.valid(null), utils_validation_1.Joi.valid(false))
+            .default(exports.DEFAULT_OPTIONS.feedOptions.limit),
     }).default(exports.DEFAULT_OPTIONS.feedOptions),
     authorsMapPath: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.authorsMapPath),
     readingTime: utils_validation_1.Joi.function().default(() => exports.DEFAULT_OPTIONS.readingTime),

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "3.0.0-alpha.0",
+  "version": "3.0.0-rc.0",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
   "scripts": {
     "build": "tsc",
-    "watch": "tsc --watch"
+    "watch": "tsc --watch",
+    "test:generate-build-snap": "yarn docusaurus build src/__tests__/__fixtures__/website --out-dir build-snap && yarn rimraf src/__tests__/__fixtures__/website/.docusaurus && yarn rimraf src/__tests__/__fixtures__/website/build-snap/assets && git add src/__tests__/__fixtures__/website/build-snap"
   },
   "repository": {
     "type": "git",
@@ -18,29 +19,30 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "3.0.0-alpha.0",
-    "@docusaurus/logger": "3.0.0-alpha.0",
-    "@docusaurus/mdx-loader": "3.0.0-alpha.0",
-    "@docusaurus/types": "3.0.0-alpha.0",
-    "@docusaurus/utils": "3.0.0-alpha.0",
-    "@docusaurus/utils-common": "3.0.0-alpha.0",
-    "@docusaurus/utils-validation": "3.0.0-alpha.0",
+    "@docusaurus/core": "3.0.0-rc.0",
+    "@docusaurus/logger": "3.0.0-rc.0",
+    "@docusaurus/mdx-loader": "3.0.0-rc.0",
+    "@docusaurus/types": "3.0.0-rc.0",
+    "@docusaurus/utils": "3.0.0-rc.0",
+    "@docusaurus/utils-common": "3.0.0-rc.0",
+    "@docusaurus/utils-validation": "3.0.0-rc.0",
     "cheerio": "^1.0.0-rc.12",
     "feed": "^4.2.2",
-    "fs-extra": "^11.1.0",
+    "fs-extra": "^11.1.1",
     "lodash": "^4.17.21",
     "reading-time": "^1.5.0",
-    "tslib": "^2.5.0",
+    "srcset": "^4.0.0",
+    "tslib": "^2.6.0",
     "unist-util-visit": "^2.0.3",
     "utility-types": "^3.10.0",
-    "webpack": "^5.76.0"
+    "webpack": "^5.88.1"
   },
   "peerDependencies": {
     "react": "^18.0.0",
     "react-dom": "^18.0.0"
   },
   "engines": {
-    "node": ">=16.14"
+    "node": ">=18.0"
   },
-  "gitHead": "7327f7ff880ed97ad7855744e59c9c55d467a950"
+  "gitHead": "e66dfe04d2972edce66f431908470c61340f8ffc"
 }

package/src/feed.ts

@@ -9,6 +9,7 @@ import path from 'path';
 import fs from 'fs-extra';
 import logger from '@docusaurus/logger';
 import {Feed, type Author as FeedAuthor} from 'feed';
+import * as srcset from 'srcset';
 import {normalizeUrl, readOutputHTMLFile} from '@docusaurus/utils';
 import {blogPostContainerID} from '@docusaurus/utils-common';
 import {load as cheerioLoad} from 'cheerio';
@@ -42,7 +43,12 @@ async function generateBlogFeed({
   const {url: siteUrl, baseUrl, title, favicon} = siteConfig;
   const blogBaseUrl = normalizeUrl([siteUrl, baseUrl, routeBasePath]);
 
-  const updated = blogPosts[0]?.metadata.date;
+  const blogPostsForFeed =
+    feedOptions.limit === false || feedOptions.limit === null
+      ? blogPosts
+      : blogPosts.slice(0, feedOptions.limit);
+
+  const updated = blogPostsForFeed[0]?.metadata.date;
 
   const feed = new Feed({
     id: blogBaseUrl,
@@ -59,7 +65,7 @@ async function generateBlogFeed({
     options.feedOptions.createFeedItems ?? defaultCreateFeedItems;
 
   const feedItems = await createFeedItems({
-    blogPosts,
+    blogPosts: blogPostsForFeed,
     siteConfig,
     outDir,
     defaultCreateFeedItems,
@@ -105,11 +111,41 @@ async function defaultCreateFeedItems({
       );
       const $ = cheerioLoad(content);
 
-      const link = normalizeUrl([siteUrl, permalink]);
+      const blogPostAbsoluteUrl = normalizeUrl([siteUrl, permalink]);
+
+      const toAbsoluteUrl = (src: string) =>
+        String(new URL(src, blogPostAbsoluteUrl));
+
+      // Make links and image urls absolute
+      // See https://github.com/facebook/docusaurus/issues/9136
+      $(`div#${blogPostContainerID} a, div#${blogPostContainerID} img`).each(
+        (_, elm) => {
+          if (elm.tagName === 'a') {
+            const {href} = elm.attribs;
+            if (href) {
+              elm.attribs.href = toAbsoluteUrl(href);
+            }
+          } else if (elm.tagName === 'img') {
+            const {src, srcset: srcsetAttr} = elm.attribs;
+            if (src) {
+              elm.attribs.src = toAbsoluteUrl(src);
+            }
+            if (srcsetAttr) {
+              elm.attribs.srcset = srcset.stringify(
+                srcset.parse(srcsetAttr).map((props) => ({
+                  ...props,
+                  url: toAbsoluteUrl(props.url),
+                })),
+              );
+            }
+          }
+        },
+      );
+
       const feedItem: BlogFeedItem = {
         title: metadataTitle,
-        id: link,
-        link,
+        id: blogPostAbsoluteUrl,
+        link: blogPostAbsoluteUrl,
         date,
         description,
         // Atom feed demands the "term", while other feeds use "name"

package/src/options.ts

@@ -22,7 +22,7 @@ import type {
 import type {OptionValidationContext} from '@docusaurus/types';
 
 export const DEFAULT_OPTIONS: PluginOptions = {
-  feedOptions: {type: ['rss', 'atom'], copyright: ''},
+  feedOptions: {type: ['rss', 'atom'], copyright: '', limit: 20},
   beforeDefaultRehypePlugins: [],
   beforeDefaultRemarkPlugins: [],
   admonitions: true,
@@ -123,6 +123,9 @@ const PluginOptionSchema = Joi.object<PluginOptions>({
     }),
     language: Joi.string(),
     createFeedItems: Joi.function(),
+    limit: Joi.alternatives()
+      .try(Joi.number(), Joi.valid(null), Joi.valid(false))
+      .default(DEFAULT_OPTIONS.feedOptions.limit),
   }).default(DEFAULT_OPTIONS.feedOptions),
   authorsMapPath: Joi.string().default(DEFAULT_OPTIONS.authorsMapPath),
   readingTime: Joi.function().default(() => DEFAULT_OPTIONS.readingTime),

package/src/plugin-content-blog.d.ts

@@ -272,6 +272,8 @@ yarn workspace v1.22.19image` is a collocated image path, this entry will be the
     language?: string;
     /** Allow control over the construction of BlogFeedItems */
     createFeedItems?: CreateFeedItemsFn;
+    /** Limits the feed to the specified number of posts, false|null for all */
+    limit?: number | false | null;
   };
 
   type DefaultCreateFeedItemsParams = {