@docusaurus/plugin-content-blog 3.3.2 → 3.5.0

package/lib/index.js

@@ -7,28 +7,58 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateOptions = void 0;
+exports.default = pluginContentBlog;
 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 authorsMap_1 = require("./authorsMap");
+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,26 +68,49 @@ 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);
         },
         // Fetches blog contents and returns metadata for the necessary routes.
         async loadContent() {
-            const { postsPerPage: postsPerPageOption, routeBasePath, tagsBasePath, blogDescription, blogTitle, blogSidebarTitle, pageBasePath, } = options;
+            const { postsPerPage: postsPerPageOption, routeBasePath, tagsBasePath, blogDescription, blogTitle, blogSidebarTitle, pageBasePath, authorsBasePath, authorsMapPath, } = options;
             const baseBlogUrl = (0, utils_1.normalizeUrl)([baseUrl, routeBasePath]);
             const blogTagsListPath = (0, utils_1.normalizeUrl)([baseBlogUrl, tagsBasePath]);
-            let blogPosts = await (0, blogUtils_1.generateBlogPosts)(contentPaths, context, options);
+            const authorsMap = await (0, authorsMap_1.getAuthorsMap)({
+                contentPaths,
+                authorsMapPath,
+                authorsBaseRoutePath: (0, utils_1.normalizeUrl)([
+                    baseUrl,
+                    routeBasePath,
+                    authorsBasePath,
+                ]),
+            });
+            (0, authorsMap_1.checkAuthorsMapPermalinkCollisions)(authorsMap);
+            let blogPosts = await (0, blogUtils_1.generateBlogPosts)(contentPaths, context, options, authorsMap);
             blogPosts = await (0, blogUtils_1.applyProcessBlogPosts)({
                 blogPosts,
                 processBlogPosts: options.processBlogPosts,
             });
+            (0, blogUtils_1.reportUntruncatedBlogPosts)({
+                blogPosts,
+                onUntruncatedBlogPosts: options.onUntruncatedBlogPosts,
+            });
             const listedBlogPosts = blogPosts.filter(blogUtils_1.shouldBeListed);
             if (!blogPosts.length) {
                 return {
@@ -66,6 +119,7 @@ async function pluginContentBlog(context, options) {
                     blogListPaginated: [],
                     blogTags: {},
                     blogTagsListPath,
+                    authorsMap,
                 };
             }
             // Collocate next and prev metadata.
@@ -108,9 +162,11 @@ async function pluginContentBlog(context, options) {
                 blogListPaginated,
                 blogTags,
                 blogTagsListPath,
+                authorsMap,
             };
         },
         async contentLoaded({ content, actions }) {
+            sourceToPermalinkHelper.update(content);
             await (0, routes_1.createAllRoutes)({
                 baseUrl,
                 content,
@@ -122,21 +178,67 @@ async function pluginContentBlog(context, options) {
         translateContent({ content, translationFiles }) {
             return (0, translations_1.translateContent)(content, translationFiles);
         },
-        configureWebpack(_config, isServer, utils, content) {
-            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}`;
-                },
-            };
+        configureWebpack() {
+            const { admonitions, rehypePlugins, remarkPlugins, recmaPlugins, truncateMarker, beforeDefaultRemarkPlugins, beforeDefaultRehypePlugins, } = options;
             const contentDirs = (0, utils_1.getContentPathList)(contentPaths);
+            function createMDXLoader() {
+                const loaderOptions = {
+                    admonitions,
+                    remarkPlugins,
+                    rehypePlugins,
+                    recmaPlugins,
+                    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,111 +252,36 @@ 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,
                 locale: currentLocale,
+                contentPaths,
             });
         },
         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 }) };
         },
     };
 }
-exports.default = pluginContentBlog;
 var options_1 = require("./options");
 Object.defineProperty(exports, "validateOptions", { enumerable: true, get: function () { return options_1.validateOptions; } });

package/lib/markdownLoader.js

@@ -6,25 +6,21 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = markdownLoader;
 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);
     }
     return callback(null, finalContent);
 }
-exports.default = markdownLoader;

package/lib/options.d.ts

@@ -4,8 +4,11 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-/// <reference path="../src/plugin-content-blog.d.ts" />
 import type { PluginOptions, Options } from '@docusaurus/plugin-content-blog';
 import type { OptionValidationContext } from '@docusaurus/types';
 export declare const DEFAULT_OPTIONS: PluginOptions;
+export declare const XSLTBuiltInPaths: {
+    rss: string;
+    atom: string;
+};
 export declare function validateOptions({ validate, options, }: OptionValidationContext<Options | undefined, PluginOptions>): PluginOptions;

package/lib/options.js

@@ -6,20 +6,34 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateOptions = exports.DEFAULT_OPTIONS = void 0;
+exports.XSLTBuiltInPaths = exports.DEFAULT_OPTIONS = void 0;
+exports.validateOptions = validateOptions;
+const tslib_1 = require("tslib");
+const path_1 = tslib_1.__importDefault(require("path"));
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const utils_1 = require("@docusaurus/utils");
 exports.DEFAULT_OPTIONS = {
-    feedOptions: { type: ['rss', 'atom'], copyright: '', limit: 20 },
+    feedOptions: {
+        type: ['rss', 'atom'],
+        copyright: '',
+        limit: 20,
+        xslt: {
+            rss: null,
+            atom: null,
+        },
+    },
     beforeDefaultRehypePlugins: [],
     beforeDefaultRemarkPlugins: [],
     admonitions: true,
     truncateMarker: /<!--\s*truncate\s*-->|\{\/\*\s*truncate\s*\*\/\}/,
     rehypePlugins: [],
     remarkPlugins: [],
+    recmaPlugins: [],
     showReadingTime: true,
     blogTagsPostsComponent: '@theme/BlogTagsPostsPage',
     blogTagsListComponent: '@theme/BlogTagsListPage',
+    blogAuthorsPostsComponent: '@theme/Blog/Pages/BlogAuthorsPostsPage',
+    blogAuthorsListComponent: '@theme/Blog/Pages/BlogAuthorsListPage',
     blogPostComponent: '@theme/BlogPostPage',
     blogListComponent: '@theme/BlogListPage',
     blogArchiveComponent: '@theme/BlogArchivePage',
@@ -42,7 +56,78 @@ exports.DEFAULT_OPTIONS = {
     showLastUpdateTime: false,
     showLastUpdateAuthor: false,
     processBlogPosts: async () => undefined,
+    onInlineTags: 'warn',
+    tags: undefined,
+    authorsBasePath: 'authors',
+    onInlineAuthors: 'warn',
+    onUntruncatedBlogPosts: 'warn',
+};
+exports.XSLTBuiltInPaths = {
+    rss: path_1.default.resolve(__dirname, '..', 'assets', 'rss.xsl'),
+    atom: path_1.default.resolve(__dirname, '..', 'assets', 'atom.xsl'),
 };
+function normalizeXsltOption(option, type) {
+    if (typeof option === 'string') {
+        return option;
+    }
+    if (option === true) {
+        return exports.XSLTBuiltInPaths[type];
+    }
+    return null;
+}
+function createXSLTFilePathSchema(type) {
+    return utils_validation_1.Joi.alternatives()
+        .try(utils_validation_1.Joi.string().required(), utils_validation_1.Joi.boolean()
+        .allow(null, () => undefined)
+        .custom((val) => normalizeXsltOption(val, type)))
+        .optional()
+        .default(null);
+}
+const FeedXSLTOptionsSchema = utils_validation_1.Joi.alternatives()
+    .try(utils_validation_1.Joi.object({
+    rss: createXSLTFilePathSchema('rss'),
+    atom: createXSLTFilePathSchema('atom'),
+}).required(), utils_validation_1.Joi.boolean()
+    .allow(null, () => undefined)
+    .custom((val) => ({
+    rss: normalizeXsltOption(val, 'rss'),
+    atom: normalizeXsltOption(val, 'atom'),
+})))
+    .optional()
+    .custom((val) => {
+    if (val === null) {
+        return {
+            rss: null,
+            atom: null,
+        };
+    }
+    return val;
+})
+    .default(exports.DEFAULT_OPTIONS.feedOptions.xslt);
+const FeedOptionsSchema = utils_validation_1.Joi.object({
+    type: utils_validation_1.Joi.alternatives()
+        .try(utils_validation_1.Joi.array().items(utils_validation_1.Joi.string().equal('rss', 'atom', 'json')), utils_validation_1.Joi.alternatives().conditional(utils_validation_1.Joi.string().equal('all', 'rss', 'atom', 'json'), {
+        then: utils_validation_1.Joi.custom((val) => val === 'all' ? ['rss', 'atom', 'json'] : [val]),
+    }))
+        .allow(null)
+        .default(exports.DEFAULT_OPTIONS.feedOptions.type),
+    xslt: FeedXSLTOptionsSchema,
+    title: utils_validation_1.Joi.string().allow(''),
+    description: utils_validation_1.Joi.string().allow(''),
+    // Only add default value when user actually wants a feed (type is not null)
+    copyright: utils_validation_1.Joi.when('type', {
+        is: utils_validation_1.Joi.any().valid(null),
+        then: utils_validation_1.Joi.string().optional(),
+        otherwise: utils_validation_1.Joi.string()
+            .allow('')
+            .default(exports.DEFAULT_OPTIONS.feedOptions.copyright),
+    }),
+    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);
 const PluginOptionSchema = utils_validation_1.Joi.object({
     path: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.path),
     archiveBasePath: utils_validation_1.Joi.string()
@@ -60,6 +145,8 @@ const PluginOptionSchema = utils_validation_1.Joi.object({
     blogPostComponent: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.blogPostComponent),
     blogTagsListComponent: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.blogTagsListComponent),
     blogTagsPostsComponent: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.blogTagsPostsComponent),
+    blogAuthorsPostsComponent: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.blogAuthorsPostsComponent),
+    blogAuthorsListComponent: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.blogAuthorsListComponent),
     blogArchiveComponent: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.blogArchiveComponent),
     blogTitle: utils_validation_1.Joi.string().allow('').default(exports.DEFAULT_OPTIONS.blogTitle),
     blogDescription: utils_validation_1.Joi.string()
@@ -72,35 +159,14 @@ const PluginOptionSchema = utils_validation_1.Joi.object({
     showReadingTime: utils_validation_1.Joi.bool().default(exports.DEFAULT_OPTIONS.showReadingTime),
     remarkPlugins: utils_validation_1.RemarkPluginsSchema.default(exports.DEFAULT_OPTIONS.remarkPlugins),
     rehypePlugins: utils_validation_1.RehypePluginsSchema.default(exports.DEFAULT_OPTIONS.rehypePlugins),
+    recmaPlugins: utils_validation_1.RecmaPluginsSchema.default(exports.DEFAULT_OPTIONS.recmaPlugins),
     admonitions: utils_validation_1.AdmonitionsSchema.default(exports.DEFAULT_OPTIONS.admonitions),
     editUrl: utils_validation_1.Joi.alternatives().try(utils_validation_1.URISchema, utils_validation_1.Joi.function()),
     editLocalizedFiles: utils_validation_1.Joi.boolean().default(exports.DEFAULT_OPTIONS.editLocalizedFiles),
     truncateMarker: utils_validation_1.Joi.object().default(exports.DEFAULT_OPTIONS.truncateMarker),
     beforeDefaultRemarkPlugins: utils_validation_1.RemarkPluginsSchema.default(exports.DEFAULT_OPTIONS.beforeDefaultRemarkPlugins),
     beforeDefaultRehypePlugins: utils_validation_1.RehypePluginsSchema.default(exports.DEFAULT_OPTIONS.beforeDefaultRehypePlugins),
-    feedOptions: utils_validation_1.Joi.object({
-        type: utils_validation_1.Joi.alternatives()
-            .try(utils_validation_1.Joi.array().items(utils_validation_1.Joi.string().equal('rss', 'atom', 'json')), utils_validation_1.Joi.alternatives().conditional(utils_validation_1.Joi.string().equal('all', 'rss', 'atom', 'json'), {
-            then: utils_validation_1.Joi.custom((val) => val === 'all' ? ['rss', 'atom', 'json'] : [val]),
-        }))
-            .allow(null)
-            .default(exports.DEFAULT_OPTIONS.feedOptions.type),
-        title: utils_validation_1.Joi.string().allow(''),
-        description: utils_validation_1.Joi.string().allow(''),
-        // Only add default value when user actually wants a feed (type is not null)
-        copyright: utils_validation_1.Joi.when('type', {
-            is: utils_validation_1.Joi.any().valid(null),
-            then: utils_validation_1.Joi.string().optional(),
-            otherwise: utils_validation_1.Joi.string()
-                .allow('')
-                .default(exports.DEFAULT_OPTIONS.feedOptions.copyright),
-        }),
-        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),
+    feedOptions: FeedOptionsSchema,
     authorsMapPath: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.authorsMapPath),
     readingTime: utils_validation_1.Joi.function().default(() => exports.DEFAULT_OPTIONS.readingTime),
     sortPosts: utils_validation_1.Joi.string()
@@ -111,9 +177,24 @@ 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),
+    authorsBasePath: utils_validation_1.Joi.string()
+        .default(exports.DEFAULT_OPTIONS.authorsBasePath)
+        .disallow(''),
+    onInlineAuthors: utils_validation_1.Joi.string()
+        .equal('ignore', 'log', 'warn', 'throw')
+        .default(exports.DEFAULT_OPTIONS.onInlineAuthors),
+    onUntruncatedBlogPosts: utils_validation_1.Joi.string()
+        .equal('ignore', 'log', 'warn', 'throw')
+        .default(exports.DEFAULT_OPTIONS.onUntruncatedBlogPosts),
 }).default(exports.DEFAULT_OPTIONS);
 function validateOptions({ validate, options, }) {
     const validatedOptions = validate(PluginOptionSchema, options);
     return validatedOptions;
 }
-exports.validateOptions = validateOptions;

package/lib/props.d.ts

@@ -1,4 +1,3 @@
-/// <reference path="../src/plugin-content-blog.d.ts" />
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
@@ -6,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { TagsListItem, TagModule } from '@docusaurus/utils';
-import type { BlogTag, BlogTags } from '@docusaurus/plugin-content-blog';
+import type { AuthorItemProp, AuthorWithKey, BlogPost, BlogSidebar, BlogTag, BlogTags } from '@docusaurus/plugin-content-blog';
 export declare function toTagsProp({ blogTags }: {
     blogTags: BlogTags;
 }): TagsListItem[];
@@ -14,3 +13,11 @@ export declare function toTagProp({ blogTagsListPath, tag, }: {
     blogTagsListPath: string;
     tag: BlogTag;
 }): TagModule;
+export declare function toAuthorItemProp({ author, count, }: {
+    author: AuthorWithKey;
+    count: number;
+}): AuthorItemProp;
+export declare function toBlogSidebarProp({ blogSidebarTitle, blogPosts, }: {
+    blogSidebarTitle: string;
+    blogPosts: BlogPost[];
+}): BlogSidebar;

package/lib/props.js

@@ -1,23 +1,43 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toTagProp = exports.toTagsProp = void 0;
+exports.toTagsProp = toTagsProp;
+exports.toTagProp = toTagProp;
+exports.toAuthorItemProp = toAuthorItemProp;
+exports.toBlogSidebarProp = toBlogSidebarProp;
 function toTagsProp({ blogTags }) {
     return Object.values(blogTags)
         .filter((tag) => !tag.unlisted)
         .map((tag) => ({
         label: tag.label,
         permalink: tag.permalink,
+        description: tag.description,
         count: tag.items.length,
     }));
 }
-exports.toTagsProp = toTagsProp;
 function toTagProp({ blogTagsListPath, tag, }) {
     return {
         label: tag.label,
         permalink: tag.permalink,
+        description: tag.description,
         allTagsPath: blogTagsListPath,
         count: tag.items.length,
         unlisted: tag.unlisted,
     };
 }
-exports.toTagProp = toTagProp;
+function toAuthorItemProp({ author, count, }) {
+    return {
+        ...author,
+        count,
+    };
+}
+function toBlogSidebarProp({ blogSidebarTitle, blogPosts, }) {
+    return {
+        title: blogSidebarTitle,
+        items: blogPosts.map((blogPost) => ({
+            title: blogPost.metadata.title,
+            permalink: blogPost.metadata.permalink,
+            unlisted: blogPost.metadata.unlisted,
+            date: blogPost.metadata.date,
+        })),
+    };
+}

package/lib/remark/footnoteIDFixer.js

@@ -6,6 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = plugin;
 const utils_1 = require("@docusaurus/utils");
 /**
  * In the blog list view, each post will be compiled separately. However, they
@@ -25,4 +26,3 @@ function plugin() {
         });
     };
 }
-exports.default = plugin;

package/lib/routes.d.ts

@@ -4,7 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-/// <reference path="../src/plugin-content-blog.d.ts" />
 import type { PluginContentLoadedActions, RouteConfig } from '@docusaurus/types';
 import type { BlogContent, PluginOptions } from '@docusaurus/plugin-content-blog';
 type CreateAllRoutesParam = {