@docusaurus/plugin-content-blog 0.0.0-4432 → 0.0.0-4436

package/lib/feed.d.ts

@@ -4,15 +4,9 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { Feed } from 'feed';
 import type { BlogPost } from './types';
 import type { DocusaurusConfig } from '@docusaurus/types';
 import type { PluginOptions } from '@docusaurus/plugin-content-blog';
-export declare function generateBlogFeed({ blogPosts, options, siteConfig, }: {
-    blogPosts: BlogPost[];
-    options: PluginOptions;
-    siteConfig: DocusaurusConfig;
-}): Promise<Feed | null>;
 export declare function createBlogFeedFiles({ blogPosts, options, siteConfig, outDir, }: {
     blogPosts: BlogPost[];
     options: PluginOptions;

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 = exports.generateBlogFeed = void 0;
+exports.createBlogFeedFiles = void 0;
 const tslib_1 = require("tslib");
 const feed_1 = require("feed");
 const utils_1 = require("@docusaurus/utils");
@@ -32,8 +32,7 @@ async function generateBlogFeed({ blogPosts, options, siteConfig, }) {
     const { feedOptions, routeBasePath } = options;
     const { url: siteUrl, baseUrl, title, favicon } = siteConfig;
     const blogBaseUrl = (0, utils_1.normalizeUrl)([siteUrl, baseUrl, routeBasePath]);
-    const updated = (blogPosts[0] && blogPosts[0].metadata.date) ||
-        new Date('2015-10-25T16:29:00.000-07:00'); // weird legacy magic date
+    const updated = blogPosts[0] && blogPosts[0].metadata.date;
     const feed = new feed_1.Feed({
         id: blogBaseUrl,
         title: feedOptions.title || `${title} Blog`,
@@ -50,13 +49,15 @@ async function generateBlogFeed({ blogPosts, options, siteConfig, }) {
         return { name: author.name, link: author.url };
     }
     blogPosts.forEach((post) => {
-        const { id, metadata: { title: metadataTitle, permalink, date, description, authors }, } = post;
+        const { id, metadata: { title: metadataTitle, permalink, date, description, authors, tags, }, } = post;
         const feedItem = {
             title: metadataTitle,
             id,
             link: (0, utils_1.normalizeUrl)([siteUrl, permalink]),
             date,
             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),
         };
         // json1() method takes the first item of authors array
@@ -69,7 +70,6 @@ async function generateBlogFeed({ blogPosts, options, siteConfig, }) {
     });
     return feed;
 }
-exports.generateBlogFeed = generateBlogFeed;
 async function createBlogFeedFile({ feed, feedType, generatePath, }) {
     const [feedContent, feedPath] = (() => {
         switch (feedType) {
@@ -84,7 +84,7 @@ async function createBlogFeedFile({ feed, feedType, generatePath, }) {
         }
     })();
     try {
-        await fs_extra_1.default.outputFile(path_1.default.join(generatePath, feedPath), feedContent);
+        await fs_extra_1.default.outputFile((0, utils_1.posixPath)(path_1.default.join(generatePath, feedPath)), feedContent);
     }
     catch (err) {
         throw new Error(`Generating ${feedType} feed failed: ${err}.`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "0.0.0-4432",
+  "version": "0.0.0-4436",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
@@ -18,11 +18,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4432",
-    "@docusaurus/logger": "0.0.0-4432",
-    "@docusaurus/mdx-loader": "0.0.0-4432",
-    "@docusaurus/utils": "0.0.0-4432",
-    "@docusaurus/utils-validation": "0.0.0-4432",
+    "@docusaurus/core": "0.0.0-4436",
+    "@docusaurus/logger": "0.0.0-4436",
+    "@docusaurus/mdx-loader": "0.0.0-4436",
+    "@docusaurus/utils": "0.0.0-4436",
+    "@docusaurus/utils-validation": "0.0.0-4436",
     "escape-string-regexp": "^4.0.0",
     "feed": "^4.2.2",
     "fs-extra": "^10.0.0",
@@ -36,7 +36,7 @@
     "webpack": "^5.61.0"
   },
   "devDependencies": {
-    "@docusaurus/types": "0.0.0-4432"
+    "@docusaurus/types": "0.0.0-4436"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
@@ -45,5 +45,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "1221cc7c66b95d2207c935645d303be70642514b"
+  "gitHead": "3b2e15935a716c69bd530fe10942e1620b36ddc4"
 }

package/src/feed.ts

@@ -7,7 +7,7 @@
 
 import {Feed, type Author as FeedAuthor, type Item as FeedItem} from 'feed';
 import type {BlogPost} from './types';
-import {normalizeUrl, mdxToHtml} from '@docusaurus/utils';
+import {normalizeUrl, mdxToHtml, posixPath} from '@docusaurus/utils';
 import type {DocusaurusConfig} from '@docusaurus/types';
 import path from 'path';
 import fs from 'fs-extra';
@@ -30,7 +30,7 @@ function mdxToFeedContent(mdxContent: string): string | undefined {
   }
 }
 
-export async function generateBlogFeed({
+async function generateBlogFeed({
   blogPosts,
   options,
   siteConfig,
@@ -47,9 +47,7 @@ export async function generateBlogFeed({
   const {url: siteUrl, baseUrl, title, favicon} = siteConfig;
   const blogBaseUrl = normalizeUrl([siteUrl, baseUrl, routeBasePath]);
 
-  const updated =
-    (blogPosts[0] && blogPosts[0].metadata.date) ||
-    new Date('2015-10-25T16:29:00.000-07:00'); // weird legacy magic date
+  const updated = blogPosts[0] && blogPosts[0].metadata.date;
 
   const feed = new Feed({
     id: blogBaseUrl,
@@ -71,7 +69,14 @@ export async function generateBlogFeed({
   blogPosts.forEach((post) => {
     const {
       id,
-      metadata: {title: metadataTitle, permalink, date, description, authors},
+      metadata: {
+        title: metadataTitle,
+        permalink,
+        date,
+        description,
+        authors,
+        tags,
+      },
     } = post;
 
     const feedItem: FeedItem = {
@@ -80,6 +85,8 @@ export async function generateBlogFeed({
       link: normalizeUrl([siteUrl, permalink]),
       date,
       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),
     };
 
@@ -118,7 +125,10 @@ async function createBlogFeedFile({
     }
   })();
   try {
-    await fs.outputFile(path.join(generatePath, feedPath), feedContent);
+    await fs.outputFile(
+      posixPath(path.join(generatePath, feedPath)),
+      feedContent,
+    );
   } catch (err) {
     throw new Error(`Generating ${feedType} feed failed: ${err}.`);
   }