@docusaurus/plugin-content-blog 2.0.0-beta.13 → 2.0.0-beta.15

package/lib/authors.d.ts

@@ -4,17 +4,14 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { Author, BlogContentPaths } from './types';
-import { BlogPostFrontMatter } from './blogFrontMatter';
+import type { BlogContentPaths } from './types';
+import type { Author, BlogPostFrontMatter } from '@docusaurus/plugin-content-blog';
 export declare type AuthorsMap = Record<string, Author>;
-export declare function validateAuthorsMapFile(content: unknown): AuthorsMap;
-export declare function readAuthorsMapFile(filePath: string): Promise<AuthorsMap | undefined>;
-declare type AuthorsMapParams = {
+export declare function validateAuthorsMap(content: unknown): AuthorsMap;
+export declare function getAuthorsMap(params: {
     authorsMapPath: string;
     contentPaths: BlogContentPaths;
-};
-export declare function getAuthorsMapFilePath({ authorsMapPath, contentPaths, }: AuthorsMapParams): Promise<string | undefined>;
-export declare function getAuthorsMap(params: AuthorsMapParams): Promise<AuthorsMap | undefined>;
+}): Promise<AuthorsMap | undefined>;
 declare type AuthorsParam = {
     frontMatter: BlogPostFrontMatter;
     authorsMap: AuthorsMap | undefined;

package/lib/authors.js

@@ -6,69 +6,32 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getBlogPostAuthors = exports.getAuthorsMap = exports.getAuthorsMapFilePath = exports.readAuthorsMapFile = exports.validateAuthorsMapFile = void 0;
-const tslib_1 = require("tslib");
-const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
-const path_1 = (0, tslib_1.__importDefault)(require("path"));
+exports.getBlogPostAuthors = exports.getAuthorsMap = exports.validateAuthorsMap = void 0;
 const utils_1 = require("@docusaurus/utils");
 const utils_validation_1 = require("@docusaurus/utils-validation");
-const blogUtils_1 = require("./blogUtils");
-const js_yaml_1 = (0, tslib_1.__importDefault)(require("js-yaml"));
 const AuthorsMapSchema = utils_validation_1.Joi.object().pattern(utils_validation_1.Joi.string(), utils_validation_1.Joi.object({
-    name: utils_validation_1.Joi.string().required(),
+    name: utils_validation_1.Joi.string(),
     url: utils_validation_1.URISchema,
     imageURL: utils_validation_1.URISchema,
     title: utils_validation_1.Joi.string(),
 })
     .rename('image_url', 'imageURL')
+    .or('name', 'imageURL')
     .unknown()
     .required());
-function validateAuthorsMapFile(content) {
+function validateAuthorsMap(content) {
     return utils_validation_1.Joi.attempt(content, AuthorsMapSchema);
 }
-exports.validateAuthorsMapFile = validateAuthorsMapFile;
-async function readAuthorsMapFile(filePath) {
-    if (await fs_extra_1.default.pathExists(filePath)) {
-        const contentString = await fs_extra_1.default.readFile(filePath, { encoding: 'utf8' });
-        try {
-            const unsafeContent = js_yaml_1.default.load(contentString);
-            return validateAuthorsMapFile(unsafeContent);
-        }
-        catch (e) {
-            // TODO replace later by error cause: see https://v8.dev/features/error-cause
-            console.error(chalk_1.default.red('The author list file looks invalid!'));
-            throw e;
-        }
-    }
-    return undefined;
-}
-exports.readAuthorsMapFile = readAuthorsMapFile;
-async function getAuthorsMapFilePath({ authorsMapPath, contentPaths, }) {
-    // Useful to load an eventually localize authors map
-    const contentPath = await (0, utils_1.findFolderContainingFile)((0, blogUtils_1.getContentPathList)(contentPaths), authorsMapPath);
-    if (contentPath) {
-        return path_1.default.join(contentPath, authorsMapPath);
-    }
-    return undefined;
-}
-exports.getAuthorsMapFilePath = getAuthorsMapFilePath;
+exports.validateAuthorsMap = validateAuthorsMap;
 async function getAuthorsMap(params) {
-    const filePath = await getAuthorsMapFilePath(params);
-    if (!filePath) {
-        return undefined;
-    }
-    try {
-        return await readAuthorsMapFile(filePath);
-    }
-    catch (e) {
-        // TODO replace later by error cause, see https://v8.dev/features/error-cause
-        console.error(chalk_1.default.red(`Couldn't read blog authors map at path ${filePath}`));
-        throw e;
-    }
+    return (0, utils_1.getDataFileData)({
+        filePath: params.authorsMapPath,
+        contentPaths: params.contentPaths,
+        fileType: 'authors map',
+    }, validateAuthorsMap);
 }
 exports.getAuthorsMap = getAuthorsMap;
-// Legacy v1/early-v2 frontmatter fields
+// Legacy v1/early-v2 front matter fields
 // We may want to deprecate those in favor of using only frontMatter.authors
 function getFrontMatterAuthorLegacy(frontMatter) {
     var _a, _b, _c;
@@ -76,7 +39,6 @@ function getFrontMatterAuthorLegacy(frontMatter) {
     const title = (_a = frontMatter.author_title) !== null && _a !== void 0 ? _a : frontMatter.authorTitle;
     const url = (_b = frontMatter.author_url) !== null && _b !== void 0 ? _b : frontMatter.authorURL;
     const imageURL = (_c = frontMatter.author_image_url) !== null && _c !== void 0 ? _c : frontMatter.authorImageURL;
-    // Shouldn't we require at least an author name?
     if (name || title || url || imageURL) {
         return {
             name,
@@ -124,7 +86,7 @@ ${Object.keys(authorsMap)
     }
     function toAuthor(frontMatterAuthor) {
         return {
-            // Author def from authorsMap can be locally overridden by frontmatter
+            // Author def from authorsMap can be locally overridden by front matter
             ...getAuthorsMapAuthor(frontMatterAuthor.key),
             ...frontMatterAuthor,
         };
@@ -135,10 +97,10 @@ function getBlogPostAuthors(params) {
     const authorLegacy = getFrontMatterAuthorLegacy(params.frontMatter);
     const authors = getFrontMatterAuthors(params);
     if (authorLegacy) {
-        // Technically, we could allow mixing legacy/authors frontmatter, but do we really want to?
+        // Technically, we could allow mixing legacy/authors front matter, but do we really want to?
         if (authors.length > 0) {
-            throw new Error(`To declare blog post authors, use the 'authors' FrontMatter in priority.
-Don't mix 'authors' with other existing 'author_*' FrontMatter. Choose one or the other, not both at the same time.`);
+            throw new Error(`To declare blog post authors, use the 'authors' front matter in priority.
+Don't mix 'authors' with other existing 'author_*' front matter. Choose one or the other, not both at the same time.`);
         }
         return [authorLegacy];
     }

package/lib/blogFrontMatter.d.ts

@@ -4,38 +4,5 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { FrontMatterTag } from '@docusaurus/utils';
-export declare type BlogPostFrontMatterAuthor = Record<string, unknown> & {
-    key?: string;
-    name?: string;
-    imageURL?: string;
-    url?: string;
-    title?: string;
-};
-export declare type BlogPostFrontMatterAuthors = string | BlogPostFrontMatterAuthor | (string | BlogPostFrontMatterAuthor)[];
-export declare type BlogPostFrontMatter = {
-    id?: string;
-    title?: string;
-    description?: string;
-    tags?: FrontMatterTag[];
-    slug?: string;
-    draft?: boolean;
-    date?: Date | string;
-    authors?: BlogPostFrontMatterAuthors;
-    author?: string;
-    author_title?: string;
-    author_url?: string;
-    author_image_url?: string;
-    /** @deprecated */
-    authorTitle?: string;
-    /** @deprecated */
-    authorURL?: string;
-    /** @deprecated */
-    authorImageURL?: string;
-    image?: string;
-    keywords?: string[];
-    hide_table_of_contents?: boolean;
-    toc_min_heading_level?: number;
-    toc_max_heading_level?: number;
-};
+import type { BlogPostFrontMatter } from '@docusaurus/plugin-content-blog';
 export declare function validateBlogPostFrontMatter(frontMatter: Record<string, unknown>): BlogPostFrontMatter;

package/lib/blogFrontMatter.js

@@ -15,7 +15,7 @@ const BlogPostFrontMatterAuthorSchema = utils_validation_1.JoiFrontMatter.object
     url: utils_validation_1.URISchema,
     imageURL: utils_validation_1.JoiFrontMatter.string(),
 })
-    .or('key', 'name')
+    .or('key', 'name', 'imageURL')
     .rename('image_url', 'imageURL', { alias: true });
 const FrontMatterAuthorErrorMessage = '{{#label}} does not look like a valid blog post author. Please use an author key or an author object (with a key and/or name).';
 const BlogFrontMatterSchema = utils_validation_1.JoiFrontMatter.object({
@@ -25,7 +25,7 @@ const BlogFrontMatterSchema = utils_validation_1.JoiFrontMatter.object({
     tags: utils_validation_1.FrontMatterTagsSchema,
     draft: utils_validation_1.JoiFrontMatter.boolean(),
     date: utils_validation_1.JoiFrontMatter.date().raw(),
-    // New multi-authors frontmatter:
+    // New multi-authors front matter:
     authors: utils_validation_1.JoiFrontMatter.alternatives()
         .try(utils_validation_1.JoiFrontMatter.string(), BlogPostFrontMatterAuthorSchema, utils_validation_1.JoiFrontMatter.array()
         .items(utils_validation_1.JoiFrontMatter.string(), BlogPostFrontMatterAuthorSchema)
@@ -36,7 +36,7 @@ const BlogFrontMatterSchema = utils_validation_1.JoiFrontMatter.object({
         .messages({
         'alternatives.match': FrontMatterAuthorErrorMessage,
     }),
-    // Legacy author frontmatter
+    // Legacy author front matter
     author: utils_validation_1.JoiFrontMatter.string(),
     author_title: utils_validation_1.JoiFrontMatter.string(),
     author_url: utils_validation_1.URISchema,

package/lib/blogUtils.d.ts

@@ -4,8 +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 { PluginOptions, BlogPost, BlogContentPaths, BlogMarkdownLoaderOptions, BlogTags } from './types';
-import { LoadContext } from '@docusaurus/types';
+import type { BlogPost, BlogContentPaths, BlogMarkdownLoaderOptions, BlogTags } from './types';
+import type { LoadContext } from '@docusaurus/types';
+import type { PluginOptions } from '@docusaurus/plugin-content-blog';
 export declare function truncate(fileString: string, truncateMarker: RegExp): string;
 export declare function getSourceToPermalink(blogPosts: BlogPost[]): Record<string, string>;
 export declare function getBlogTags(blogPosts: BlogPost[]): BlogTags;
@@ -21,5 +22,4 @@ export declare type LinkifyParams = {
     fileString: string;
 } & Pick<BlogMarkdownLoaderOptions, 'sourceToPermalink' | 'siteDir' | 'contentPaths' | 'onBrokenMarkdownLink'>;
 export declare function linkify({ filePath, contentPaths, fileString, siteDir, sourceToPermalink, onBrokenMarkdownLink, }: LinkifyParams): string;
-export declare function getContentPathList(contentPaths: BlogContentPaths): string[];
 export {};

package/lib/blogUtils.js

@@ -6,16 +6,16 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getContentPathList = exports.linkify = exports.generateBlogPosts = exports.parseBlogFileName = exports.getBlogTags = exports.getSourceToPermalink = exports.truncate = void 0;
+exports.linkify = exports.generateBlogPosts = exports.parseBlogFileName = exports.getBlogTags = exports.getSourceToPermalink = exports.truncate = void 0;
 const tslib_1 = require("tslib");
 const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
-const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
 const path_1 = (0, tslib_1.__importDefault)(require("path"));
 const reading_time_1 = (0, tslib_1.__importDefault)(require("reading-time"));
 const lodash_1 = require("lodash");
 const utils_1 = require("@docusaurus/utils");
 const blogFrontMatter_1 = require("./blogFrontMatter");
 const authors_1 = require("./authors");
+const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
 function truncate(fileString, truncateMarker) {
     return fileString.split(truncateMarker, 1).shift();
 }
@@ -33,16 +33,15 @@ function getBlogTags(blogPosts) {
     }));
 }
 exports.getBlogTags = getBlogTags;
-const DATE_FILENAME_REGEX = /^(?<date>\d{4}[-/]\d{1,2}[-/]\d{1,2})[-/]?(?<text>.*?)(\/index)?.mdx?$/;
+const DATE_FILENAME_REGEX = /^(?<folder>.*)(?<date>\d{4}[-/]\d{1,2}[-/]\d{1,2})[-/]?(?<text>.*?)(\/index)?.mdx?$/;
 function parseBlogFileName(blogSourceRelative) {
     const dateFilenameMatch = blogSourceRelative.match(DATE_FILENAME_REGEX);
     if (dateFilenameMatch) {
-        const dateString = dateFilenameMatch.groups.date;
-        const text = dateFilenameMatch.groups.text;
+        const { folder, text, date: dateString } = dateFilenameMatch.groups;
         // Always treat dates as UTC by adding the `Z`
         const date = new Date(`${dateString}Z`);
         const slugDate = dateString.replace(/-/g, '/');
-        const slug = `/${slugDate}/${text}`;
+        const slug = `/${slugDate}/${folder}${text}`;
         return { date, text, slug };
     }
     else {
@@ -66,13 +65,19 @@ function formatBlogPostDate(locale, date) {
     }
 }
 async function parseBlogPostMarkdownFile(blogSourceAbsolute) {
-    const result = await (0, utils_1.parseMarkdownFile)(blogSourceAbsolute, {
-        removeContentTitle: true,
-    });
-    return {
-        ...result,
-        frontMatter: (0, blogFrontMatter_1.validateBlogPostFrontMatter)(result.frontMatter),
-    };
+    const markdownString = await fs_extra_1.default.readFile(blogSourceAbsolute, 'utf-8');
+    try {
+        const result = (0, utils_1.parseMarkdownString)(markdownString, {
+            removeContentTitle: true,
+        });
+        return {
+            ...result,
+            frontMatter: (0, blogFrontMatter_1.validateBlogPostFrontMatter)(result.frontMatter),
+        };
+    }
+    catch (e) {
+        throw new Error(`Error while parsing blog post file ${blogSourceAbsolute}: "${e.message}".`);
+    }
 }
 const defaultReadingTime = ({ content, options }) => (0, reading_time_1.default)(content, options).minutes;
 async function processBlogSourceFile(blogSourceRelative, contentPaths, context, options, authorsMap) {
@@ -80,7 +85,7 @@ async function processBlogSourceFile(blogSourceRelative, contentPaths, context,
     const { siteConfig: { baseUrl }, siteDir, i18n, } = context;
     const { routeBasePath, tagsBasePath: tagsRouteBasePath, truncateMarker, showReadingTime, editUrl, } = options;
     // Lookup in localized folder in priority
-    const blogDirPath = await (0, utils_1.getFolderContainingFile)(getContentPathList(contentPaths), blogSourceRelative);
+    const blogDirPath = await (0, utils_1.getFolderContainingFile)((0, utils_1.getContentPathList)(contentPaths), blogSourceRelative);
     const blogSourceAbsolute = path_1.default.join(blogDirPath, blogSourceRelative);
     const { frontMatter, content, contentTitle, excerpt } = await parseBlogPostMarkdownFile(blogSourceAbsolute);
     const aliasedSource = (0, utils_1.aliasedSitePath)(blogSourceAbsolute, siteDir);
@@ -88,13 +93,18 @@ async function processBlogSourceFile(blogSourceRelative, contentPaths, context,
         return undefined;
     }
     if (frontMatter.id) {
-        console.warn(chalk_1.default.yellow(`"id" header option is deprecated in ${blogSourceRelative} file. Please use "slug" option instead.`));
+        logger_1.default.warn `name=${'id'} header option is deprecated in path=${blogSourceRelative} file. Please use name=${'slug'} option instead.`;
     }
     const parsedBlogFileName = parseBlogFileName(blogSourceRelative);
     async function getDate() {
         // Prefer user-defined date.
         if (frontMatter.date) {
-            return new Date(frontMatter.date);
+            if (typeof frontMatter.date === 'string') {
+                // Always treat dates as UTC by adding the `Z`
+                return new Date(`${frontMatter.date}Z`);
+            }
+            // YAML only converts YYYY-MM-DD to dates and leaves others as strings.
+            return frontMatter.date;
         }
         else if (parsedBlogFileName.date) {
             return parsedBlogFileName.date;
@@ -157,6 +167,7 @@ async function processBlogSourceFile(blogSourceRelative, contentPaths, context,
                 : undefined,
             truncated: (truncateMarker === null || truncateMarker === void 0 ? void 0 : truncateMarker.test(content)) || false,
             authors,
+            frontMatter,
         },
         content,
     };
@@ -179,7 +190,7 @@ async function generateBlogPosts(contentPaths, context, options) {
             return await processBlogSourceFile(blogSourceFile, contentPaths, context, options, authorsMap);
         }
         catch (e) {
-            console.error(chalk_1.default.red(`Processing of blog source file failed for path "${blogSourceFile}"`));
+            logger_1.default.error `Processing of blog source file failed for path path=${blogSourceFile}.`;
             throw e;
         }
     }))).filter(Boolean);
@@ -202,8 +213,3 @@ function linkify({ filePath, contentPaths, fileString, siteDir, sourceToPermalin
     return newContent;
 }
 exports.linkify = linkify;
-// Order matters: we look in priority in localized folder
-function getContentPathList(contentPaths) {
-    return [contentPaths.contentPathLocalized, contentPaths.contentPath];
-}
-exports.getContentPathList = getContentPathList;

package/lib/feed.d.ts

@@ -4,14 +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 { PluginOptions, BlogPost } from './types';
-import { DocusaurusConfig } from '@docusaurus/types';
-export declare function generateBlogFeed({ blogPosts, options, siteConfig, }: {
-    blogPosts: BlogPost[];
-    options: PluginOptions;
-    siteConfig: DocusaurusConfig;
-}): Promise<Feed | null>;
+import type { BlogPost } from './types';
+import type { DocusaurusConfig } from '@docusaurus/types';
+import type { PluginOptions } from '@docusaurus/plugin-content-blog';
 export declare function createBlogFeedFiles({ blogPosts, options, siteConfig, outDir, }: {
     blogPosts: BlogPost[];
     options: PluginOptions;

package/lib/feed.js

@@ -6,34 +6,22 @@
  * 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");
+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;
     }
     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`,
@@ -49,42 +37,65 @@ async function generateBlogFeed({ blogPosts, options, siteConfig, }) {
         // RSS feed requires email to render authors
         return { name: author.name, link: author.url };
     }
-    blogPosts.forEach((post) => {
-        const { id, metadata: { title: metadataTitle, permalink, date, description, authors }, } = post;
-        feed.addItem({
+    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,
             link: (0, utils_1.normalizeUrl)([siteUrl, permalink]),
             date,
             description,
-            content: mdxToFeedContent(post.content),
-            author: authors.map(toFeedAuthor),
-        });
+            // Atom feed demands the "term", while other feeds use "name"
+            category: tags.map((tag) => ({ name: tag.label, term: tag.label })),
+            content: $(`#${utils_common_1.blogPostContainerID}`).html(),
+        };
+        // json1() method takes the first item of authors array
+        // it causes an error when authors array is empty
+        const feedItemAuthors = authors.map(toFeedAuthor);
+        if (feedItemAuthors.length > 0) {
+            feedItem.author = feedItemAuthors;
+        }
+        feed.addItem(feedItem);
     });
     return feed;
 }
-exports.generateBlogFeed = generateBlogFeed;
-async function createBlogFeedFile({ feed, feedType, filePath, }) {
-    const feedContent = feedType === 'rss' ? feed.rss2() : feed.atom1();
+async function createBlogFeedFile({ feed, feedType, generatePath, }) {
+    const [feedContent, feedPath] = (() => {
+        switch (feedType) {
+            case 'rss':
+                return [feed.rss2(), 'rss.xml'];
+            case 'json':
+                return [feed.json1(), 'feed.json'];
+            case 'atom':
+                return [feed.atom1(), 'atom.xml'];
+            default:
+                throw new Error(`Feed type ${feedType} not supported.`);
+        }
+    })();
     try {
-        await fs_extra_1.default.outputFile(filePath, 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}.`);
     }
 }
 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;
     }
-    await Promise.all(feedTypes.map(async (feedType) => {
-        await createBlogFeedFile({
-            feed,
-            feedType,
-            filePath: path_1.default.join(outDir, options.routeBasePath, `${feedType}.xml`),
-        });
-    }));
+    await Promise.all(feedTypes.map((feedType) => createBlogFeedFile({
+        feed,
+        feedType,
+        generatePath: path_1.default.join(outDir, options.routeBasePath),
+    })));
 }
 exports.createBlogFeedFiles = createBlogFeedFiles;

package/lib/index.d.ts

@@ -4,7 +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 { PluginOptions, BlogContent } from './types';
-import { LoadContext, Plugin, OptionValidationContext, ValidationResult } from '@docusaurus/types';
-export default function pluginContentBlog(context: LoadContext, options: PluginOptions): Plugin<BlogContent>;
+import type { BlogContent } from './types';
+import type { LoadContext, Plugin, OptionValidationContext, ValidationResult } from '@docusaurus/types';
+import type { PluginOptions } from '@docusaurus/plugin-content-blog';
+export default function pluginContentBlog(context: LoadContext, options: PluginOptions): Promise<Plugin<BlogContent>>;
 export declare function validateOptions({ validate, options, }: OptionValidationContext<PluginOptions>): ValidationResult<PluginOptions>;

package/lib/index.js

@@ -15,7 +15,7 @@ const translations_1 = require("./translations");
 const pluginOptionSchema_1 = require("./pluginOptionSchema");
 const blogUtils_1 = require("./blogUtils");
 const feed_1 = require("./feed");
-function pluginContentBlog(context, options) {
+async function pluginContentBlog(context, options) {
     var _a;
     if (options.admonitions) {
         options.remarkPlugins = options.remarkPlugins.concat([
@@ -37,16 +37,16 @@ function pluginContentBlog(context, options) {
     const pluginDataDirRoot = path_1.default.join(generatedFilesDir, 'docusaurus-plugin-content-blog');
     const dataDir = path_1.default.join(pluginDataDirRoot, pluginId);
     const aliasedSource = (source) => `~blog/${(0, utils_1.posixPath)(path_1.default.relative(pluginDataDirRoot, source))}`;
+    const authorsMapFilePath = await (0, utils_1.getDataFilePath)({
+        filePath: options.authorsMapPath,
+        contentPaths,
+    });
     return {
         name: 'docusaurus-plugin-content-blog',
         getPathsToWatch() {
-            const { include, authorsMapPath } = options;
-            const contentMarkdownGlobs = (0, blogUtils_1.getContentPathList)(contentPaths).flatMap((contentPath) => include.map((pattern) => `${contentPath}/${pattern}`));
-            // TODO: we should read this path in plugin! but plugins do not support async init for now :'(
-            // const authorsMapFilePath = await getAuthorsMapFilePath({authorsMapPath,contentPaths,});
-            // simplified impl, better than nothing for now:
-            const authorsMapFilePath = path_1.default.join(contentPaths.contentPath, authorsMapPath);
-            return [authorsMapFilePath, ...contentMarkdownGlobs];
+            const { include } = options;
+            const contentMarkdownGlobs = (0, utils_1.getContentPathList)(contentPaths).flatMap((contentPath) => include.map((pattern) => `${contentPath}/${pattern}`));
+            return [authorsMapFilePath, ...contentMarkdownGlobs].filter(Boolean);
         },
         async getTranslationFiles() {
             return (0, translations_1.getTranslationFiles)(options);
@@ -135,21 +135,23 @@ function pluginContentBlog(context, options) {
             const sidebarBlogPosts = options.blogSidebarCount === 'ALL'
                 ? blogPosts
                 : blogPosts.slice(0, options.blogSidebarCount);
-            const archiveUrl = (0, utils_1.normalizeUrl)([
-                baseUrl,
-                routeBasePath,
-                archiveBasePath,
-            ]);
-            // creates a blog archive route
-            const archiveProp = await createData(`${(0, utils_1.docuHash)(archiveUrl)}.json`, JSON.stringify({ blogPosts }, null, 2));
-            addRoute({
-                path: archiveUrl,
-                component: '@theme/BlogArchivePage',
-                exact: true,
-                modules: {
-                    archive: aliasedSource(archiveProp),
-                },
-            });
+            if (archiveBasePath) {
+                const archiveUrl = (0, utils_1.normalizeUrl)([
+                    baseUrl,
+                    routeBasePath,
+                    archiveBasePath,
+                ]);
+                // creates a blog archive route
+                const archiveProp = await createData(`${(0, utils_1.docuHash)(archiveUrl)}.json`, JSON.stringify({ blogPosts }, null, 2));
+                addRoute({
+                    path: archiveUrl,
+                    component: '@theme/BlogArchivePage',
+                    exact: true,
+                    modules: {
+                        archive: aliasedSource(archiveProp),
+                    },
+                });
+            }
             // This prop is useful to provide the blog list sidebar
             const sidebarProp = await createData(
             // Note that this created data path must be in sync with
@@ -274,7 +276,7 @@ function pluginContentBlog(context, options) {
                     (0, utils_1.reportMessage)(`Blog markdown link couldn't be resolved: (${brokenMarkdownLink.link}) in ${brokenMarkdownLink.filePath}`, onBrokenMarkdownLinks);
                 },
             };
-            const contentDirs = (0, blogUtils_1.getContentPathList)(contentPaths);
+            const contentDirs = (0, utils_1.getContentPathList)(contentPaths);
             return {
                 resolve: {
                     alias: {
@@ -326,13 +328,11 @@ 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;
             }
@@ -364,6 +364,11 @@ function pluginContentBlog(context, options) {
                     path: 'atom.xml',
                     title: `${feedTitle} Atom Feed`,
                 },
+                json: {
+                    type: 'application/json',
+                    path: 'feed.json',
+                    title: `${feedTitle} JSON Feed`,
+                },
             };
             const headTags = [];
             feedTypes.forEach((feedType) => {

package/lib/markdownLoader.d.ts

@@ -4,6 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { BlogMarkdownLoaderOptions } from './types';
+import type { BlogMarkdownLoaderOptions } from './types';
 import type { LoaderContext } from 'webpack';
 export default function markdownLoader(this: LoaderContext<BlogMarkdownLoaderOptions>, source: string): void;

package/lib/markdownLoader.js

@@ -7,7 +7,6 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const blogUtils_1 = require("./blogUtils");
-const loader_utils_1 = require("loader-utils");
 function markdownLoader(source) {
     const filePath = this.resourcePath;
     const fileString = source;
@@ -21,7 +20,7 @@ function markdownLoader(source) {
     });
     // Truncate content if requested (e.g: file.md?truncated=true).
     const truncated = this.resourceQuery
-        ? !!(0, loader_utils_1.parseQuery)(this.resourceQuery).truncated
+        ? !!new URLSearchParams(this.resourceQuery.slice(1)).get('truncated')
         : undefined;
     if (truncated) {
         finalContent = (0, blogUtils_1.truncate)(finalContent, markdownLoaderOptions.truncateMarker);

package/lib/pluginOptionSchema.d.ts

@@ -5,6 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { Joi } from '@docusaurus/utils-validation';
-import { PluginOptions } from './types';
+import type { PluginOptions } from '@docusaurus/plugin-content-blog';
 export declare const DEFAULT_OPTIONS: PluginOptions;
 export declare const PluginOptionSchema: Joi.ObjectSchema<PluginOptions>;