@docusaurus/plugin-content-blog 3.3.2 → 3.4.0

package/lib/blogUtils.d.ts

@@ -7,11 +7,8 @@
 /// <reference path="../src/plugin-content-blog.d.ts" />
 import type { LoadContext } from '@docusaurus/types';
 import type { PluginOptions, BlogPost, BlogTags, BlogPaginated } from '@docusaurus/plugin-content-blog';
-import type { BlogContentPaths, BlogMarkdownLoaderOptions } from './types';
+import type { BlogContentPaths } from './types';
 export declare function truncate(fileString: string, truncateMarker: RegExp): string;
-export declare function getSourceToPermalink(blogPosts: BlogPost[]): {
-    [aliasedPath: string]: string;
-};
 export declare function paginateBlogPosts({ blogPosts, basePageUrl, blogTitle, blogDescription, postsPerPageOption, pageBasePath, }: {
     blogPosts: BlogPost[];
     basePageUrl: string;
@@ -35,11 +32,6 @@ type ParsedBlogFileName = {
 };
 export declare function parseBlogFileName(blogSourceRelative: string): ParsedBlogFileName;
 export declare function generateBlogPosts(contentPaths: BlogContentPaths, context: LoadContext, options: PluginOptions): Promise<BlogPost[]>;
-export type LinkifyParams = {
-    filePath: string;
-    fileString: string;
-} & Pick<BlogMarkdownLoaderOptions, 'sourceToPermalink' | 'siteDir' | 'contentPaths' | 'onBrokenMarkdownLink'>;
-export declare function linkify({ filePath, contentPaths, fileString, siteDir, sourceToPermalink, onBrokenMarkdownLink, }: LinkifyParams): string;
 export declare function applyProcessBlogPosts({ blogPosts, processBlogPosts, }: {
     blogPosts: BlogPost[];
     processBlogPosts: PluginOptions['processBlogPosts'];

package/lib/blogUtils.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.applyProcessBlogPosts = exports.linkify = exports.generateBlogPosts = exports.parseBlogFileName = exports.getBlogTags = exports.shouldBeListed = exports.paginateBlogPosts = exports.getSourceToPermalink = exports.truncate = void 0;
+exports.applyProcessBlogPosts = exports.generateBlogPosts = exports.parseBlogFileName = exports.getBlogTags = exports.shouldBeListed = exports.paginateBlogPosts = exports.truncate = void 0;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
@@ -14,16 +14,13 @@ const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const reading_time_1 = tslib_1.__importDefault(require("reading-time"));
 const utils_1 = require("@docusaurus/utils");
+const utils_validation_1 = require("@docusaurus/utils-validation");
 const frontMatter_1 = require("./frontMatter");
 const authors_1 = require("./authors");
 function truncate(fileString, truncateMarker) {
     return fileString.split(truncateMarker, 1).shift();
 }
 exports.truncate = truncate;
-function getSourceToPermalink(blogPosts) {
-    return Object.fromEntries(blogPosts.map(({ metadata: { source, permalink } }) => [source, permalink]));
-}
-exports.getSourceToPermalink = getSourceToPermalink;
 function paginateBlogPosts({ blogPosts, basePageUrl, blogTitle, blogDescription, postsPerPageOption, pageBasePath, }) {
     const totalCount = blogPosts.length;
     const postsPerPage = postsPerPageOption === 'ALL' ? totalCount : postsPerPageOption;
@@ -67,9 +64,11 @@ function getBlogTags({ blogPosts, ...params }) {
             isUnlisted: (item) => item.metadata.unlisted,
         });
         return {
+            inline: tag.inline,
             label: tag.label,
-            items: tagVisibility.listedItems.map((item) => item.id),
             permalink: tag.permalink,
+            description: tag.description,
+            items: tagVisibility.listedItems.map((item) => item.id),
             pages: paginateBlogPosts({
                 blogPosts: tagVisibility.listedItems,
                 basePageUrl: tag.permalink,
@@ -116,7 +115,7 @@ async function parseBlogPostMarkdownFile({ filePath, parseFrontMatter, }) {
     }
 }
 const defaultReadingTime = ({ content, options }) => (0, reading_time_1.default)(content, options).minutes;
-async function processBlogSourceFile(blogSourceRelative, contentPaths, context, options, authorsMap) {
+async function processBlogSourceFile(blogSourceRelative, contentPaths, context, options, tagsFile, authorsMap) {
     const { siteConfig: { baseUrl, markdown: { parseFrontMatter }, }, siteDir, i18n, } = context;
     const { routeBasePath, tagsBasePath: tagsRouteBasePath, truncateMarker, showReadingTime, editUrl, } = options;
     // Lookup in localized folder in priority
@@ -190,12 +189,19 @@ async function processBlogSourceFile(blogSourceRelative, contentPaths, context,
         }
         return undefined;
     }
-    const tagsBasePath = (0, utils_1.normalizeUrl)([
+    const tagsBaseRoutePath = (0, utils_1.normalizeUrl)([
         baseUrl,
         routeBasePath,
         tagsRouteBasePath,
     ]);
     const authors = (0, authors_1.getBlogPostAuthors)({ authorsMap, frontMatter, baseUrl });
+    const tags = (0, utils_1.normalizeTags)({
+        options,
+        source: blogSourceRelative,
+        frontMatterTags: frontMatter.tags,
+        tagsBaseRoutePath,
+        tagsFile,
+    });
     return {
         id: slug,
         metadata: {
@@ -205,7 +211,7 @@ async function processBlogSourceFile(blogSourceRelative, contentPaths, context,
             title,
             description,
             date,
-            tags: (0, utils_1.normalizeFrontMatterTags)(tagsBasePath, frontMatter.tags),
+            tags,
             readingTime: showReadingTime
                 ? options.readingTime({
                     content,
@@ -236,9 +242,10 @@ async function generateBlogPosts(contentPaths, context, options) {
         contentPaths,
         authorsMapPath: options.authorsMapPath,
     });
+    const tagsFile = await (0, utils_validation_1.getTagsFile)({ contentPaths, tags: options.tags });
     async function doProcessBlogSourceFile(blogSourceFile) {
         try {
-            return await processBlogSourceFile(blogSourceFile, contentPaths, context, options, authorsMap);
+            return await processBlogSourceFile(blogSourceFile, contentPaths, context, options, tagsFile, authorsMap);
         }
         catch (err) {
             throw new Error(`Processing of blog source file path=${blogSourceFile} failed.`, { cause: err });
@@ -252,18 +259,6 @@ async function generateBlogPosts(contentPaths, context, options) {
     return blogPosts;
 }
 exports.generateBlogPosts = generateBlogPosts;
-function linkify({ filePath, contentPaths, fileString, siteDir, sourceToPermalink, onBrokenMarkdownLink, }) {
-    const { newContent, brokenMarkdownLinks } = (0, utils_1.replaceMarkdownLinks)({
-        siteDir,
-        fileString,
-        filePath,
-        contentPaths,
-        sourceToPermalink,
-    });
-    brokenMarkdownLinks.forEach((l) => onBrokenMarkdownLink(l));
-    return newContent;
-}
-exports.linkify = linkify;
 async function applyProcessBlogPosts({ blogPosts, processBlogPosts, }) {
     const processedBlogPosts = await processBlogPosts({ blogPosts });
     if (Array.isArray(processedBlogPosts)) {

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

@@ -11,24 +11,52 @@ const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const utils_1 = require("@docusaurus/utils");
+const utils_validation_1 = require("@docusaurus/utils-validation");
 const blogUtils_1 = require("./blogUtils");
 const footnoteIDFixer_1 = tslib_1.__importDefault(require("./remark/footnoteIDFixer"));
 const translations_1 = require("./translations");
 const feed_1 = require("./feed");
 const routes_1 = require("./routes");
+const PluginName = 'docusaurus-plugin-content-blog';
+// TODO this is bad, we should have a better way to do this (new lifecycle?)
+//  The source to permalink is currently a mutable map passed to the mdx loader
+//  for link resolution
+//  see https://github.com/facebook/docusaurus/pull/10185
+function createSourceToPermalinkHelper() {
+    const sourceToPermalink = new Map();
+    function computeSourceToPermalink(content) {
+        return new Map(content.blogPosts.map(({ metadata: { source, permalink } }) => [
+            source,
+            permalink,
+        ]));
+    }
+    // Mutable map update :/
+    function update(content) {
+        sourceToPermalink.clear();
+        computeSourceToPermalink(content).forEach((value, key) => {
+            sourceToPermalink.set(key, value);
+        });
+    }
+    return { get: () => sourceToPermalink, update };
+}
 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
@@ -38,12 +66,21 @@ async function pluginContentBlog(context, options) {
         filePath: options.authorsMapPath,
         contentPaths,
     });
+    const sourceToPermalinkHelper = createSourceToPermalinkHelper();
     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}`));
-            return [authorsMapFilePath, ...contentMarkdownGlobs].filter(Boolean);
+            const tagsFilePaths = (0, utils_validation_1.getTagsFilePathsToWatch)({
+                contentPaths,
+                tags: options.tags,
+            });
+            return [
+                authorsMapFilePath,
+                ...tagsFilePaths,
+                ...contentMarkdownGlobs,
+            ].filter(Boolean);
         },
         getTranslationFiles() {
             return (0, translations_1.getTranslationFiles)(options);
@@ -111,6 +148,7 @@ async function pluginContentBlog(context, options) {
             };
         },
         async contentLoaded({ content, actions }) {
+            sourceToPermalinkHelper.update(content);
             await (0, routes_1.createAllRoutes)({
                 baseUrl,
                 content,
@@ -122,21 +160,66 @@ async function pluginContentBlog(context, options) {
         translateContent({ content, translationFiles }) {
             return (0, translations_1.translateContent)(content, translationFiles);
         },
-        configureWebpack(_config, isServer, utils, content) {
+        configureWebpack() {
             const { admonitions, rehypePlugins, remarkPlugins, truncateMarker, beforeDefaultRemarkPlugins, beforeDefaultRehypePlugins, } = options;
-            const markdownLoaderOptions = {
-                siteDir,
-                contentPaths,
-                truncateMarker,
-                sourceToPermalink: (0, blogUtils_1.getSourceToPermalink)(content.blogPosts),
-                onBrokenMarkdownLink: (brokenMarkdownLink) => {
-                    if (onBrokenMarkdownLinks === 'ignore') {
-                        return;
-                    }
-                    logger_1.default.report(onBrokenMarkdownLinks) `Blog markdown link couldn't be resolved: (url=${brokenMarkdownLink.link}) in path=${brokenMarkdownLink.filePath}`;
-                },
-            };
             const contentDirs = (0, utils_1.getContentPathList)(contentPaths);
+            function createMDXLoader() {
+                const loaderOptions = {
+                    admonitions,
+                    remarkPlugins,
+                    rehypePlugins,
+                    beforeDefaultRemarkPlugins: [
+                        footnoteIDFixer_1.default,
+                        ...beforeDefaultRemarkPlugins,
+                    ],
+                    beforeDefaultRehypePlugins,
+                    staticDirs: siteConfig.staticDirectories.map((dir) => path_1.default.resolve(siteDir, dir)),
+                    siteDir,
+                    isMDXPartial: (0, utils_1.createAbsoluteFilePathMatcher)(options.exclude, contentDirs),
+                    metadataPath: (mdxPath) => {
+                        // Note that metadataPath must be the same/in-sync as
+                        // the path from createData for each MDX.
+                        const aliasedPath = (0, utils_1.aliasedSitePath)(mdxPath, siteDir);
+                        return path_1.default.join(dataDir, `${(0, utils_1.docuHash)(aliasedPath)}.json`);
+                    },
+                    // For blog posts a title in markdown is always removed
+                    // Blog posts title are rendered separately
+                    removeContentTitle: true,
+                    // Assets allow to convert some relative images paths to
+                    // require() calls
+                    // @ts-expect-error: TODO fix typing issue
+                    createAssets: ({ frontMatter, metadata, }) => ({
+                        image: frontMatter.image,
+                        authorsImageUrls: metadata.authors.map((author) => author.imageURL),
+                    }),
+                    markdownConfig: siteConfig.markdown,
+                    resolveMarkdownLink: ({ linkPathname, sourceFilePath }) => {
+                        const permalink = (0, utils_1.resolveMarkdownLinkPathname)(linkPathname, {
+                            sourceFilePath,
+                            sourceToPermalink: sourceToPermalinkHelper.get(),
+                            siteDir,
+                            contentPaths,
+                        });
+                        if (permalink === null) {
+                            logger_1.default.report(onBrokenMarkdownLinks) `Blog markdown link couldn't be resolved: (url=${linkPathname}) in source file path=${sourceFilePath}`;
+                        }
+                        return permalink;
+                    },
+                };
+                return {
+                    loader: require.resolve('@docusaurus/mdx-loader'),
+                    options: loaderOptions,
+                };
+            }
+            function createBlogMarkdownLoader() {
+                const loaderOptions = {
+                    truncateMarker,
+                };
+                return {
+                    loader: path_1.default.resolve(__dirname, './markdownLoader.js'),
+                    options: loaderOptions,
+                };
+            }
             return {
                 resolve: {
                     alias: {
@@ -150,59 +233,20 @@ async function pluginContentBlog(context, options) {
                             include: contentDirs
                                 // Trailing slash is important, see https://github.com/facebook/docusaurus/pull/3970
                                 .map(utils_1.addTrailingPathSeparator),
-                            use: [
-                                {
-                                    loader: require.resolve('@docusaurus/mdx-loader'),
-                                    options: {
-                                        admonitions,
-                                        remarkPlugins,
-                                        rehypePlugins,
-                                        beforeDefaultRemarkPlugins: [
-                                            footnoteIDFixer_1.default,
-                                            ...beforeDefaultRemarkPlugins,
-                                        ],
-                                        beforeDefaultRehypePlugins,
-                                        staticDirs: siteConfig.staticDirectories.map((dir) => path_1.default.resolve(siteDir, dir)),
-                                        siteDir,
-                                        isMDXPartial: (0, utils_1.createAbsoluteFilePathMatcher)(options.exclude, contentDirs),
-                                        metadataPath: (mdxPath) => {
-                                            // Note that metadataPath must be the same/in-sync as
-                                            // the path from createData for each MDX.
-                                            const aliasedPath = (0, utils_1.aliasedSitePath)(mdxPath, siteDir);
-                                            return path_1.default.join(dataDir, `${(0, utils_1.docuHash)(aliasedPath)}.json`);
-                                        },
-                                        // For blog posts a title in markdown is always removed
-                                        // Blog posts title are rendered separately
-                                        removeContentTitle: true,
-                                        // Assets allow to convert some relative images paths to
-                                        // require() calls
-                                        createAssets: ({ frontMatter, metadata, }) => ({
-                                            image: frontMatter.image,
-                                            authorsImageUrls: metadata.authors.map((author) => author.imageURL),
-                                        }),
-                                        markdownConfig: siteConfig.markdown,
-                                    },
-                                },
-                                {
-                                    loader: path_1.default.resolve(__dirname, './markdownLoader.js'),
-                                    options: markdownLoaderOptions,
-                                },
-                            ].filter(Boolean),
+                            use: [createMDXLoader(), createBlogMarkdownLoader()],
                         },
                     ],
                 },
             };
         },
         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 +254,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/lib/markdownLoader.js

@@ -8,20 +8,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const blogUtils_1 = require("./blogUtils");
 function markdownLoader(source) {
-    const filePath = this.resourcePath;
     const fileString = source;
     const callback = this.async();
     const markdownLoaderOptions = this.getOptions();
     // Linkify blog posts
-    let finalContent = (0, blogUtils_1.linkify)({
-        fileString,
-        filePath,
-        ...markdownLoaderOptions,
-    });
+    let finalContent = fileString;
     // Truncate content if requested (e.g: file.md?truncated=true).
     const truncated = this.resourceQuery
         ? !!new URLSearchParams(this.resourceQuery.slice(1)).get('truncated')
         : undefined;
+    // TODO truncate with the AST instead of the string ?
     if (truncated) {
         finalContent = (0, blogUtils_1.truncate)(finalContent, markdownLoaderOptions.truncateMarker);
     }

package/lib/options.js

@@ -42,6 +42,8 @@ exports.DEFAULT_OPTIONS = {
     showLastUpdateTime: false,
     showLastUpdateAuthor: false,
     processBlogPosts: async () => undefined,
+    onInlineTags: 'warn',
+    tags: undefined,
 };
 const PluginOptionSchema = utils_validation_1.Joi.object({
     path: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.path),
@@ -111,6 +113,13 @@ const PluginOptionSchema = utils_validation_1.Joi.object({
     processBlogPosts: utils_validation_1.Joi.function()
         .optional()
         .default(() => exports.DEFAULT_OPTIONS.processBlogPosts),
+    onInlineTags: utils_validation_1.Joi.string()
+        .equal('ignore', 'log', 'warn', 'throw')
+        .default(exports.DEFAULT_OPTIONS.onInlineTags),
+    tags: utils_validation_1.Joi.string()
+        .disallow('')
+        .allow(null, false)
+        .default(() => exports.DEFAULT_OPTIONS.tags),
 }).default(exports.DEFAULT_OPTIONS);
 function validateOptions({ validate, options, }) {
     const validatedOptions = validate(PluginOptionSchema, options);

package/lib/props.js

@@ -7,6 +7,7 @@ function toTagsProp({ blogTags }) {
         .map((tag) => ({
         label: tag.label,
         permalink: tag.permalink,
+        description: tag.description,
         count: tag.items.length,
     }));
 }
@@ -15,6 +16,7 @@ function toTagProp({ blogTagsListPath, tag, }) {
     return {
         label: tag.label,
         permalink: tag.permalink,
+        description: tag.description,
         allTagsPath: blogTagsListPath,
         count: tag.items.length,
         unlisted: tag.unlisted,

package/lib/types.d.ts

@@ -4,15 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { BrokenMarkdownLink, ContentPaths } from '@docusaurus/utils';
+import type { ContentPaths } from '@docusaurus/utils';
 export type BlogContentPaths = ContentPaths;
-export type BlogBrokenMarkdownLink = BrokenMarkdownLink<BlogContentPaths>;
 export type BlogMarkdownLoaderOptions = {
-    siteDir: string;
-    contentPaths: BlogContentPaths;
     truncateMarker: RegExp;
-    sourceToPermalink: {
-        [aliasedPath: string]: string;
-    };
-    onBrokenMarkdownLink: (brokenMarkdownLink: BlogBrokenMarkdownLink) => void;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "3.3.2",
+  "version": "3.4.0",
   "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": "3.3.2",
-    "@docusaurus/logger": "3.3.2",
-    "@docusaurus/mdx-loader": "3.3.2",
-    "@docusaurus/types": "3.3.2",
-    "@docusaurus/utils": "3.3.2",
-    "@docusaurus/utils-common": "3.3.2",
-    "@docusaurus/utils-validation": "3.3.2",
+    "@docusaurus/core": "3.4.0",
+    "@docusaurus/logger": "3.4.0",
+    "@docusaurus/mdx-loader": "3.4.0",
+    "@docusaurus/types": "3.4.0",
+    "@docusaurus/utils": "3.4.0",
+    "@docusaurus/utils-common": "3.4.0",
+    "@docusaurus/utils-validation": "3.4.0",
     "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": "bc638d674bfbde1e254ef306697f47e764b5e107"
+  "gitHead": "49e9a2143274a8dd795659b417b470bc42abbd6e"
 }