@docusaurus/plugin-content-blog 0.0.0-4485 → 0.0.0-4489

package/lib/feed.js

@@ -10,22 +10,11 @@ exports.createBlogFeedFiles = void 0;
 const tslib_1 = require("tslib");
 const feed_1 = require("feed");
 const utils_1 = require("@docusaurus/utils");
+const cheerio_1 = (0, tslib_1.__importDefault)(require("cheerio"));
 const path_1 = (0, tslib_1.__importDefault)(require("path"));
 const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
-// TODO this is temporary until we handle mdxToHtml better
-// It's hard to convert reliably JSX/require calls  to an html feed content
-// See https://github.com/facebook/docusaurus/issues/5664
-function mdxToFeedContent(mdxContent) {
-    try {
-        return (0, utils_1.mdxToHtml)(mdxContent);
-    }
-    catch (e) {
-        // TODO will we need a plugin option to configure how to handle such an error
-        // Swallow the error on purpose for now, until we understand better the problem space
-        return undefined;
-    }
-}
-async function generateBlogFeed({ blogPosts, options, siteConfig, }) {
+const utils_common_1 = require("@docusaurus/utils-common");
+async function generateBlogFeed({ blogPosts, options, siteConfig, outDir, }) {
     if (!blogPosts.length) {
         return null;
     }
@@ -48,8 +37,10 @@ async function generateBlogFeed({ blogPosts, options, siteConfig, }) {
         // RSS feed requires email to render authors
         return { name: author.name, link: author.url };
     }
-    blogPosts.forEach((post) => {
+    await (0, utils_1.mapAsyncSequential)(blogPosts, async (post) => {
         const { id, metadata: { title: metadataTitle, permalink, date, description, authors, tags, }, } = post;
+        const content = await (0, utils_1.readOutputHTMLFile)(permalink.replace(siteConfig.baseUrl, ''), outDir, siteConfig.trailingSlash);
+        const $ = cheerio_1.default.load(content);
         const feedItem = {
             title: metadataTitle,
             id,
@@ -58,7 +49,7 @@ async function generateBlogFeed({ blogPosts, options, siteConfig, }) {
             description,
             // Atom feed demands the "term", while other feeds use "name"
             category: tags.map((tag) => ({ name: tag.label, term: tag.label })),
-            content: mdxToFeedContent(post.content),
+            content: $(`#${utils_common_1.blogPostContainerID}`).html(),
         };
         // json1() method takes the first item of authors array
         // it causes an error when authors array is empty
@@ -91,7 +82,12 @@ async function createBlogFeedFile({ feed, feedType, generatePath, }) {
     }
 }
 async function createBlogFeedFiles({ blogPosts, options, siteConfig, outDir, }) {
-    const feed = await generateBlogFeed({ blogPosts, options, siteConfig });
+    const feed = await generateBlogFeed({
+        blogPosts,
+        options,
+        siteConfig,
+        outDir,
+    });
     const feedTypes = options.feedOptions.type;
     if (!feed || !feedTypes) {
         return;

package/lib/index.js

@@ -328,13 +328,11 @@ async function pluginContentBlog(context, options) {
                 },
             };
         },
-        async postBuild({ outDir }) {
+        async postBuild({ outDir, content }) {
             if (!options.feedOptions.type) {
                 return;
             }
-            // TODO: we shouldn't need to re-read the posts here!
-            // postBuild should receive loadedContent
-            const blogPosts = await (0, blogUtils_1.generateBlogPosts)(contentPaths, context, options);
+            const { blogPosts } = content;
             if (!blogPosts.length) {
                 return;
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "0.0.0-4485",
+  "version": "0.0.0-4489",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
@@ -18,11 +18,13 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4485",
-    "@docusaurus/logger": "0.0.0-4485",
-    "@docusaurus/mdx-loader": "0.0.0-4485",
-    "@docusaurus/utils": "0.0.0-4485",
-    "@docusaurus/utils-validation": "0.0.0-4485",
+    "@docusaurus/core": "0.0.0-4489",
+    "@docusaurus/logger": "0.0.0-4489",
+    "@docusaurus/mdx-loader": "0.0.0-4489",
+    "@docusaurus/utils": "0.0.0-4489",
+    "@docusaurus/utils-common": "0.0.0-4489",
+    "@docusaurus/utils-validation": "0.0.0-4489",
+    "cheerio": "^1.0.0-rc.10",
     "feed": "^4.2.2",
     "fs-extra": "^10.0.0",
     "lodash": "^4.17.20",
@@ -33,7 +35,7 @@
     "webpack": "^5.61.0"
   },
   "devDependencies": {
-    "@docusaurus/types": "0.0.0-4485",
+    "@docusaurus/types": "0.0.0-4489",
     "escape-string-regexp": "^4.0.0"
   },
   "peerDependencies": {
@@ -43,5 +45,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "c21382b895098d7d65193e04f5977ed073d3f26e"
+  "gitHead": "f4020aaf26717ce5e5085a949cf3b7e088bc386f"
 }

package/src/feed.ts

@@ -7,7 +7,13 @@
 
 import {Feed, type Author as FeedAuthor, type Item as FeedItem} from 'feed';
 import type {BlogPost} from './types';
-import {normalizeUrl, mdxToHtml, posixPath} from '@docusaurus/utils';
+import {
+  normalizeUrl,
+  posixPath,
+  mapAsyncSequential,
+  readOutputHTMLFile,
+} from '@docusaurus/utils';
+import cheerio from 'cheerio';
 import type {DocusaurusConfig} from '@docusaurus/types';
 import path from 'path';
 import fs from 'fs-extra';
@@ -16,28 +22,18 @@ import type {
   PluginOptions,
   Author,
 } from '@docusaurus/plugin-content-blog';
-
-// TODO this is temporary until we handle mdxToHtml better
-// It's hard to convert reliably JSX/require calls  to an html feed content
-// See https://github.com/facebook/docusaurus/issues/5664
-function mdxToFeedContent(mdxContent: string): string | undefined {
-  try {
-    return mdxToHtml(mdxContent);
-  } catch (e) {
-    // TODO will we need a plugin option to configure how to handle such an error
-    // Swallow the error on purpose for now, until we understand better the problem space
-    return undefined;
-  }
-}
+import {blogPostContainerID} from '@docusaurus/utils-common';
 
 async function generateBlogFeed({
   blogPosts,
   options,
   siteConfig,
+  outDir,
 }: {
   blogPosts: BlogPost[];
   options: PluginOptions;
   siteConfig: DocusaurusConfig;
+  outDir: string;
 }): Promise<Feed | null> {
   if (!blogPosts.length) {
     return null;
@@ -66,7 +62,7 @@ async function generateBlogFeed({
     return {name: author.name, link: author.url};
   }
 
-  blogPosts.forEach((post) => {
+  await mapAsyncSequential(blogPosts, async (post) => {
     const {
       id,
       metadata: {
@@ -79,6 +75,13 @@ async function generateBlogFeed({
       },
     } = post;
 
+    const content = await readOutputHTMLFile(
+      permalink.replace(siteConfig.baseUrl, ''),
+      outDir,
+      siteConfig.trailingSlash,
+    );
+    const $ = cheerio.load(content);
+
     const feedItem: FeedItem = {
       title: metadataTitle,
       id,
@@ -87,7 +90,7 @@ async function generateBlogFeed({
       description,
       // Atom feed demands the "term", while other feeds use "name"
       category: tags.map((tag) => ({name: tag.label, term: tag.label})),
-      content: mdxToFeedContent(post.content),
+      content: $(`#${blogPostContainerID}`).html()!,
     };
 
     // json1() method takes the first item of authors array
@@ -145,7 +148,12 @@ export async function createBlogFeedFiles({
   siteConfig: DocusaurusConfig;
   outDir: string;
 }): Promise<void> {
-  const feed = await generateBlogFeed({blogPosts, options, siteConfig});
+  const feed = await generateBlogFeed({
+    blogPosts,
+    options,
+    siteConfig,
+    outDir,
+  });
 
   const feedTypes = options.feedOptions.type;
   if (!feed || !feedTypes) {

package/src/index.ts

@@ -36,7 +36,6 @@ import {PluginOptionSchema} from './pluginOptionSchema';
 import type {
   LoadContext,
   ConfigureWebpackUtils,
-  Props,
   Plugin,
   HtmlTags,
   OptionValidationContext,
@@ -512,14 +511,11 @@ export default async function pluginContentBlog(
       };
     },
 
-    async postBuild({outDir}: Props) {
+    async postBuild({outDir, content}) {
       if (!options.feedOptions.type) {
         return;
       }
-
-      // TODO: we shouldn't need to re-read the posts here!
-      // postBuild should receive loadedContent
-      const blogPosts = await generateBlogPosts(contentPaths, context, options);
+      const {blogPosts} = content;
       if (!blogPosts.length) {
         return;
       }