@docusaurus/plugin-content-blog 0.0.0-5945 → 0.0.0-5946

package/lib/feed.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 /// <reference path="../src/plugin-content-blog.d.ts" />
-import type { DocusaurusConfig } from '@docusaurus/types';
+import type { DocusaurusConfig, HtmlTags, LoadContext } from '@docusaurus/types';
 import type { PluginOptions, BlogPost } from '@docusaurus/plugin-content-blog';
 export declare function createBlogFeedFiles({ blogPosts: allBlogPosts, options, siteConfig, outDir, locale, }: {
     blogPosts: BlogPost[];
@@ -14,3 +14,7 @@ export declare function createBlogFeedFiles({ blogPosts: allBlogPosts, options,
     outDir: string;
     locale: string;
 }): Promise<void>;
+export declare function createFeedHtmlHeadTags({ context, options, }: {
+    context: LoadContext;
+    options: PluginOptions;
+}): HtmlTags;

package/lib/feed.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createBlogFeedFiles = void 0;
+exports.createFeedHtmlHeadTags = exports.createBlogFeedFiles = void 0;
 const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
@@ -151,3 +151,46 @@ async function createBlogFeedFiles({ blogPosts: allBlogPosts, options, siteConfi
     })));
 }
 exports.createBlogFeedFiles = createBlogFeedFiles;
+function createFeedHtmlHeadTags({ context, options, }) {
+    const feedTypes = options.feedOptions.type;
+    if (!feedTypes) {
+        return [];
+    }
+    const feedTitle = options.feedOptions.title ?? context.siteConfig.title;
+    const feedsConfig = {
+        rss: {
+            type: 'application/rss+xml',
+            path: 'rss.xml',
+            title: `${feedTitle} RSS Feed`,
+        },
+        atom: {
+            type: 'application/atom+xml',
+            path: 'atom.xml',
+            title: `${feedTitle} Atom Feed`,
+        },
+        json: {
+            type: 'application/json',
+            path: 'feed.json',
+            title: `${feedTitle} JSON Feed`,
+        },
+    };
+    const headTags = [];
+    feedTypes.forEach((feedType) => {
+        const { type, path: feedConfigPath, title: feedConfigTitle, } = feedsConfig[feedType];
+        headTags.push({
+            tagName: 'link',
+            attributes: {
+                rel: 'alternate',
+                type,
+                href: (0, utils_1.normalizeUrl)([
+                    context.siteConfig.baseUrl,
+                    options.routeBasePath,
+                    feedConfigPath,
+                ]),
+                title: feedConfigTitle,
+            },
+        });
+    });
+    return headTags;
+}
+exports.createFeedHtmlHeadTags = createFeedHtmlHeadTags;

package/lib/index.js

@@ -16,19 +16,25 @@ const footnoteIDFixer_1 = tslib_1.__importDefault(require("./remark/footnoteIDFi
 const translations_1 = require("./translations");
 const feed_1 = require("./feed");
 const routes_1 = require("./routes");
+const PluginName = 'docusaurus-plugin-content-blog';
 async function pluginContentBlog(context, options) {
     const { siteDir, siteConfig, generatedFilesDir, localizationDir, i18n: { currentLocale }, } = context;
+    const router = siteConfig.future.experimental_router;
+    const isBlogFeedDisabledBecauseOfHashRouter = router === 'hash' && !!options.feedOptions.type;
+    if (isBlogFeedDisabledBecauseOfHashRouter) {
+        logger_1.default.warn(`${PluginName} feed feature does not support the Hash Router. Feeds won't be generated.`);
+    }
     const { onBrokenMarkdownLinks, baseUrl } = siteConfig;
     const contentPaths = {
         contentPath: path_1.default.resolve(siteDir, options.path),
         contentPathLocalized: (0, utils_1.getPluginI18nPath)({
             localizationDir,
-            pluginName: 'docusaurus-plugin-content-blog',
+            pluginName: PluginName,
             pluginId: options.id,
         }),
     };
     const pluginId = options.id ?? utils_1.DEFAULT_PLUGIN_ID;
-    const pluginDataDirRoot = path_1.default.join(generatedFilesDir, 'docusaurus-plugin-content-blog');
+    const pluginDataDirRoot = path_1.default.join(generatedFilesDir, PluginName);
     const dataDir = path_1.default.join(pluginDataDirRoot, pluginId);
     // TODO Docusaurus v4 breaking change
     //  module aliasing should be automatic
@@ -39,7 +45,7 @@ async function pluginContentBlog(context, options) {
         contentPaths,
     });
     return {
-        name: 'docusaurus-plugin-content-blog',
+        name: PluginName,
         getPathsToWatch() {
             const { include } = options;
             const contentMarkdownGlobs = (0, utils_1.getContentPathList)(contentPaths).flatMap((contentPath) => include.map((pattern) => `${contentPath}/${pattern}`));
@@ -194,15 +200,13 @@ async function pluginContentBlog(context, options) {
             };
         },
         async postBuild({ outDir, content }) {
-            if (!options.feedOptions.type) {
-                return;
-            }
-            const { blogPosts } = content;
-            if (!blogPosts.length) {
+            if (!content.blogPosts.length ||
+                !options.feedOptions.type ||
+                isBlogFeedDisabledBecauseOfHashRouter) {
                 return;
             }
             await (0, feed_1.createBlogFeedFiles)({
-                blogPosts,
+                blogPosts: content.blogPosts,
                 options,
                 outDir,
                 siteConfig,
@@ -210,48 +214,12 @@ async function pluginContentBlog(context, options) {
             });
         },
         injectHtmlTags({ content }) {
-            if (!content.blogPosts.length || !options.feedOptions.type) {
+            if (!content.blogPosts.length ||
+                !options.feedOptions.type ||
+                isBlogFeedDisabledBecauseOfHashRouter) {
                 return {};
             }
-            const feedTypes = options.feedOptions.type;
-            const feedTitle = options.feedOptions.title ?? context.siteConfig.title;
-            const feedsConfig = {
-                rss: {
-                    type: 'application/rss+xml',
-                    path: 'rss.xml',
-                    title: `${feedTitle} RSS Feed`,
-                },
-                atom: {
-                    type: 'application/atom+xml',
-                    path: 'atom.xml',
-                    title: `${feedTitle} Atom Feed`,
-                },
-                json: {
-                    type: 'application/json',
-                    path: 'feed.json',
-                    title: `${feedTitle} JSON Feed`,
-                },
-            };
-            const headTags = [];
-            feedTypes.forEach((feedType) => {
-                const { type, path: feedConfigPath, title: feedConfigTitle, } = feedsConfig[feedType];
-                headTags.push({
-                    tagName: 'link',
-                    attributes: {
-                        rel: 'alternate',
-                        type,
-                        href: (0, utils_1.normalizeUrl)([
-                            baseUrl,
-                            options.routeBasePath,
-                            feedConfigPath,
-                        ]),
-                        title: feedConfigTitle,
-                    },
-                });
-            });
-            return {
-                headTags,
-            };
+            return { headTags: (0, feed_1.createFeedHtmlHeadTags)({ context, options }) };
         },
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "0.0.0-5945",
+  "version": "0.0.0-5946",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
@@ -31,13 +31,13 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-5945",
-    "@docusaurus/logger": "0.0.0-5945",
-    "@docusaurus/mdx-loader": "0.0.0-5945",
-    "@docusaurus/types": "0.0.0-5945",
-    "@docusaurus/utils": "0.0.0-5945",
-    "@docusaurus/utils-common": "0.0.0-5945",
-    "@docusaurus/utils-validation": "0.0.0-5945",
+    "@docusaurus/core": "0.0.0-5946",
+    "@docusaurus/logger": "0.0.0-5946",
+    "@docusaurus/mdx-loader": "0.0.0-5946",
+    "@docusaurus/types": "0.0.0-5946",
+    "@docusaurus/utils": "0.0.0-5946",
+    "@docusaurus/utils-common": "0.0.0-5946",
+    "@docusaurus/utils-validation": "0.0.0-5946",
     "cheerio": "^1.0.0-rc.12",
     "feed": "^4.2.2",
     "fs-extra": "^11.1.1",
@@ -59,5 +59,5 @@
   "devDependencies": {
     "@total-typescript/shoehorn": "^0.1.2"
   },
-  "gitHead": "93d26c046a449a18fd39d96f34d08518f833cdf3"
+  "gitHead": "22332e32d47aea6bc27ca36b2ef50f12cd1427c8"
 }

package/src/feed.ts

@@ -16,7 +16,7 @@ import {
   applyTrailingSlash,
 } from '@docusaurus/utils-common';
 import {load as cheerioLoad} from 'cheerio';
-import type {DocusaurusConfig} from '@docusaurus/types';
+import type {DocusaurusConfig, HtmlTags, LoadContext} from '@docusaurus/types';
 import type {
   FeedType,
   PluginOptions,
@@ -254,3 +254,59 @@ export async function createBlogFeedFiles({
     ),
   );
 }
+
+export function createFeedHtmlHeadTags({
+  context,
+  options,
+}: {
+  context: LoadContext;
+  options: PluginOptions;
+}): HtmlTags {
+  const feedTypes = options.feedOptions.type;
+  if (!feedTypes) {
+    return [];
+  }
+  const feedTitle = options.feedOptions.title ?? context.siteConfig.title;
+  const feedsConfig = {
+    rss: {
+      type: 'application/rss+xml',
+      path: 'rss.xml',
+      title: `${feedTitle} RSS Feed`,
+    },
+    atom: {
+      type: 'application/atom+xml',
+      path: 'atom.xml',
+      title: `${feedTitle} Atom Feed`,
+    },
+    json: {
+      type: 'application/json',
+      path: 'feed.json',
+      title: `${feedTitle} JSON Feed`,
+    },
+  };
+  const headTags: HtmlTags = [];
+
+  feedTypes.forEach((feedType) => {
+    const {
+      type,
+      path: feedConfigPath,
+      title: feedConfigTitle,
+    } = feedsConfig[feedType];
+
+    headTags.push({
+      tagName: 'link',
+      attributes: {
+        rel: 'alternate',
+        type,
+        href: normalizeUrl([
+          context.siteConfig.baseUrl,
+          options.routeBasePath,
+          feedConfigPath,
+        ]),
+        title: feedConfigTitle,
+      },
+    });
+  });
+
+  return headTags;
+}

package/src/index.ts

@@ -29,11 +29,11 @@ import {
 } from './blogUtils';
 import footnoteIDFixer from './remark/footnoteIDFixer';
 import {translateContent, getTranslationFiles} from './translations';
-import {createBlogFeedFiles} from './feed';
+import {createBlogFeedFiles, createFeedHtmlHeadTags} from './feed';
 
 import {createAllRoutes} from './routes';
 import type {BlogContentPaths, BlogMarkdownLoaderOptions} from './types';
-import type {LoadContext, Plugin, HtmlTags} from '@docusaurus/types';
+import type {LoadContext, Plugin} from '@docusaurus/types';
 import type {
   PluginOptions,
   BlogPostFrontMatter,
@@ -44,6 +44,8 @@ import type {
   BlogPaginated,
 } from '@docusaurus/plugin-content-blog';
 
+const PluginName = 'docusaurus-plugin-content-blog';
+
 export default async function pluginContentBlog(
   context: LoadContext,
   options: PluginOptions,
@@ -55,22 +57,29 @@ export default async function pluginContentBlog(
     localizationDir,
     i18n: {currentLocale},
   } = context;
+
+  const router = siteConfig.future.experimental_router;
+  const isBlogFeedDisabledBecauseOfHashRouter =
+    router === 'hash' && !!options.feedOptions.type;
+  if (isBlogFeedDisabledBecauseOfHashRouter) {
+    logger.warn(
+      `${PluginName} feed feature does not support the Hash Router. Feeds won't be generated.`,
+    );
+  }
+
   const {onBrokenMarkdownLinks, baseUrl} = siteConfig;
 
   const contentPaths: BlogContentPaths = {
     contentPath: path.resolve(siteDir, options.path),
     contentPathLocalized: getPluginI18nPath({
       localizationDir,
-      pluginName: 'docusaurus-plugin-content-blog',
+      pluginName: PluginName,
       pluginId: options.id,
     }),
   };
   const pluginId = options.id ?? DEFAULT_PLUGIN_ID;
 
-  const pluginDataDirRoot = path.join(
-    generatedFilesDir,
-    'docusaurus-plugin-content-blog',
-  );
+  const pluginDataDirRoot = path.join(generatedFilesDir, PluginName);
   const dataDir = path.join(pluginDataDirRoot, pluginId);
   // TODO Docusaurus v4 breaking change
   //  module aliasing should be automatic
@@ -84,7 +93,7 @@ export default async function pluginContentBlog(
   });
 
   return {
-    name: 'docusaurus-plugin-content-blog',
+    name: PluginName,
 
     getPathsToWatch() {
       const {include} = options;
@@ -295,15 +304,16 @@ export default async function pluginContentBlog(
     },
 
     async postBuild({outDir, content}) {
-      if (!options.feedOptions.type) {
-        return;
-      }
-      const {blogPosts} = content;
-      if (!blogPosts.length) {
+      if (
+        !content.blogPosts.length ||
+        !options.feedOptions.type ||
+        isBlogFeedDisabledBecauseOfHashRouter
+      ) {
         return;
       }
+
       await createBlogFeedFiles({
-        blogPosts,
+        blogPosts: content.blogPosts,
         options,
         outDir,
         siteConfig,
@@ -312,56 +322,15 @@ export default async function pluginContentBlog(
     },
 
     injectHtmlTags({content}) {
-      if (!content.blogPosts.length || !options.feedOptions.type) {
+      if (
+        !content.blogPosts.length ||
+        !options.feedOptions.type ||
+        isBlogFeedDisabledBecauseOfHashRouter
+      ) {
         return {};
       }
 
-      const feedTypes = options.feedOptions.type;
-      const feedTitle = options.feedOptions.title ?? context.siteConfig.title;
-      const feedsConfig = {
-        rss: {
-          type: 'application/rss+xml',
-          path: 'rss.xml',
-          title: `${feedTitle} RSS Feed`,
-        },
-        atom: {
-          type: 'application/atom+xml',
-          path: 'atom.xml',
-          title: `${feedTitle} Atom Feed`,
-        },
-        json: {
-          type: 'application/json',
-          path: 'feed.json',
-          title: `${feedTitle} JSON Feed`,
-        },
-      };
-      const headTags: HtmlTags = [];
-
-      feedTypes.forEach((feedType) => {
-        const {
-          type,
-          path: feedConfigPath,
-          title: feedConfigTitle,
-        } = feedsConfig[feedType];
-
-        headTags.push({
-          tagName: 'link',
-          attributes: {
-            rel: 'alternate',
-            type,
-            href: normalizeUrl([
-              baseUrl,
-              options.routeBasePath,
-              feedConfigPath,
-            ]),
-            title: feedConfigTitle,
-          },
-        });
-      });
-
-      return {
-        headTags,
-      };
+      return {headTags: createFeedHtmlHeadTags({context, options})};
     },
   };
 }