@docusaurus/plugin-content-blog 3.0.0 → 3.1.0

package/lib/authors.d.ts

@@ -17,6 +17,7 @@ export declare function getAuthorsMap(params: {
 type AuthorsParam = {
     frontMatter: BlogPostFrontMatter;
     authorsMap: AuthorsMap | undefined;
+    baseUrl: string;
 };
 export declare function getBlogPostAuthors(params: AuthorsParam): Author[];
 export {};

package/lib/authors.js

@@ -44,13 +44,21 @@ async function getAuthorsMap(params) {
     }, validateAuthorsMap);
 }
 exports.getAuthorsMap = getAuthorsMap;
+function normalizeImageUrl({ imageURL, baseUrl, }) {
+    return imageURL?.startsWith('/')
+        ? (0, utils_1.normalizeUrl)([baseUrl, imageURL])
+        : imageURL;
+}
 // Legacy v1/early-v2 front matter fields
 // We may want to deprecate those in favor of using only frontMatter.authors
-function getFrontMatterAuthorLegacy(frontMatter) {
+function getFrontMatterAuthorLegacy({ baseUrl, frontMatter, }) {
     const name = frontMatter.author;
     const title = frontMatter.author_title ?? frontMatter.authorTitle;
     const url = frontMatter.author_url ?? frontMatter.authorURL;
-    const imageURL = frontMatter.author_image_url ?? frontMatter.authorImageURL;
+    const imageURL = normalizeImageUrl({
+        imageURL: frontMatter.author_image_url ?? frontMatter.authorImageURL,
+        baseUrl,
+    });
     if (name || title || url || imageURL) {
         return {
             name,
@@ -105,18 +113,25 @@ ${Object.keys(authorsMap)
     }
     return frontMatterAuthors.map(toAuthor);
 }
+function fixAuthorImageBaseURL(authors, { baseUrl }) {
+    return authors.map((author) => ({
+        ...author,
+        imageURL: normalizeImageUrl({ imageURL: author.imageURL, baseUrl }),
+    }));
+}
 function getBlogPostAuthors(params) {
-    const authorLegacy = getFrontMatterAuthorLegacy(params.frontMatter);
+    const authorLegacy = getFrontMatterAuthorLegacy(params);
     const authors = getFrontMatterAuthors(params);
+    const updatedAuthors = fixAuthorImageBaseURL(authors, params);
     if (authorLegacy) {
         // Technically, we could allow mixing legacy/authors front matter, but do we
         // really want to?
-        if (authors.length > 0) {
+        if (updatedAuthors.length > 0) {
             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];
     }
-    return authors;
+    return updatedAuthors;
 }
 exports.getBlogPostAuthors = getBlogPostAuthors;

package/lib/blogUtils.js

@@ -111,10 +111,13 @@ function formatBlogPostDate(locale, date, calendar) {
         throw err;
     }
 }
-async function parseBlogPostMarkdownFile(blogSourceAbsolute) {
-    const markdownString = await fs_extra_1.default.readFile(blogSourceAbsolute, 'utf-8');
+async function parseBlogPostMarkdownFile({ filePath, parseFrontMatter, }) {
+    const fileContent = await fs_extra_1.default.readFile(filePath, 'utf-8');
     try {
-        const result = (0, utils_1.parseMarkdownString)(markdownString, {
+        const result = await (0, utils_1.parseMarkdownFile)({
+            filePath,
+            fileContent,
+            parseFrontMatter,
             removeContentTitle: true,
         });
         return {
@@ -123,18 +126,21 @@ async function parseBlogPostMarkdownFile(blogSourceAbsolute) {
         };
     }
     catch (err) {
-        logger_1.default.error `Error while parsing blog post file path=${blogSourceAbsolute}.`;
+        logger_1.default.error `Error while parsing blog post file path=${filePath}.`;
         throw err;
     }
 }
 const defaultReadingTime = ({ content, options }) => (0, reading_time_1.default)(content, options).minutes;
 async function processBlogSourceFile(blogSourceRelative, contentPaths, context, options, authorsMap) {
-    const { siteConfig: { baseUrl }, siteDir, i18n, } = context;
+    const { siteConfig: { baseUrl, markdown: { parseFrontMatter }, }, siteDir, i18n, } = context;
     const { routeBasePath, tagsBasePath: tagsRouteBasePath, truncateMarker, showReadingTime, editUrl, } = options;
     // Lookup in localized folder in priority
     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 { frontMatter, content, contentTitle, excerpt } = await parseBlogPostMarkdownFile({
+        filePath: blogSourceAbsolute,
+        parseFrontMatter,
+    });
     const aliasedSource = (0, utils_1.aliasedSitePath)(blogSourceAbsolute, siteDir);
     const draft = (0, utils_1.isDraft)({ frontMatter });
     const unlisted = (0, utils_1.isUnlisted)({ frontMatter });
@@ -204,7 +210,7 @@ async function processBlogSourceFile(blogSourceRelative, contentPaths, context,
         routeBasePath,
         tagsRouteBasePath,
     ]);
-    const authors = (0, authors_1.getBlogPostAuthors)({ authorsMap, frontMatter });
+    const authors = (0, authors_1.getBlogPostAuthors)({ authorsMap, frontMatter, baseUrl });
     return {
         id: slug,
         metadata: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
@@ -19,13 +19,13 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "3.0.0",
-    "@docusaurus/logger": "3.0.0",
-    "@docusaurus/mdx-loader": "3.0.0",
-    "@docusaurus/types": "3.0.0",
-    "@docusaurus/utils": "3.0.0",
-    "@docusaurus/utils-common": "3.0.0",
-    "@docusaurus/utils-validation": "3.0.0",
+    "@docusaurus/core": "3.1.0",
+    "@docusaurus/logger": "3.1.0",
+    "@docusaurus/mdx-loader": "3.1.0",
+    "@docusaurus/types": "3.1.0",
+    "@docusaurus/utils": "3.1.0",
+    "@docusaurus/utils-common": "3.1.0",
+    "@docusaurus/utils-validation": "3.1.0",
     "cheerio": "^1.0.0-rc.12",
     "feed": "^4.2.2",
     "fs-extra": "^11.1.1",
@@ -44,5 +44,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "ca8b4638c47119d38838656c4a11ee3a5e7ba6f2"
+  "gitHead": "a5e675821f0e8b70b591fcebf19fd60a70d55548"
 }

package/src/authors.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {getDataFileData} from '@docusaurus/utils';
+import {getDataFileData, normalizeUrl} from '@docusaurus/utils';
 import {Joi, URISchema} from '@docusaurus/utils-validation';
 import type {BlogContentPaths} from './types';
 import type {
@@ -68,17 +68,37 @@ export async function getAuthorsMap(params: {
 type AuthorsParam = {
   frontMatter: BlogPostFrontMatter;
   authorsMap: AuthorsMap | undefined;
+  baseUrl: string;
 };
 
+function normalizeImageUrl({
+  imageURL,
+  baseUrl,
+}: {
+  imageURL: string | undefined;
+  baseUrl: string;
+}) {
+  return imageURL?.startsWith('/')
+    ? normalizeUrl([baseUrl, imageURL])
+    : imageURL;
+}
+
 // Legacy v1/early-v2 front matter fields
 // We may want to deprecate those in favor of using only frontMatter.authors
-function getFrontMatterAuthorLegacy(
-  frontMatter: BlogPostFrontMatter,
-): Author | undefined {
+function getFrontMatterAuthorLegacy({
+  baseUrl,
+  frontMatter,
+}: {
+  baseUrl: string;
+  frontMatter: BlogPostFrontMatter;
+}): Author | undefined {
   const name = frontMatter.author;
   const title = frontMatter.author_title ?? frontMatter.authorTitle;
   const url = frontMatter.author_url ?? frontMatter.authorURL;
-  const imageURL = frontMatter.author_image_url ?? frontMatter.authorImageURL;
+  const imageURL = normalizeImageUrl({
+    imageURL: frontMatter.author_image_url ?? frontMatter.authorImageURL,
+    baseUrl,
+  });
 
   if (name || title || url || imageURL) {
     return {
@@ -148,14 +168,26 @@ ${Object.keys(authorsMap)
   return frontMatterAuthors.map(toAuthor);
 }
 
+function fixAuthorImageBaseURL(
+  authors: Author[],
+  {baseUrl}: {baseUrl: string},
+) {
+  return authors.map((author) => ({
+    ...author,
+    imageURL: normalizeImageUrl({imageURL: author.imageURL, baseUrl}),
+  }));
+}
+
 export function getBlogPostAuthors(params: AuthorsParam): Author[] {
-  const authorLegacy = getFrontMatterAuthorLegacy(params.frontMatter);
+  const authorLegacy = getFrontMatterAuthorLegacy(params);
   const authors = getFrontMatterAuthors(params);
 
+  const updatedAuthors = fixAuthorImageBaseURL(authors, params);
+
   if (authorLegacy) {
     // Technically, we could allow mixing legacy/authors front matter, but do we
     // really want to?
-    if (authors.length > 0) {
+    if (updatedAuthors.length > 0) {
       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.`,
@@ -164,5 +196,5 @@ Don't mix 'authors' with other existing 'author_*' front matter. Choose one or t
     return [authorLegacy];
   }
 
-  return authors;
+  return updatedAuthors;
 }

package/src/blogUtils.ts

@@ -11,7 +11,7 @@ import _ from 'lodash';
 import logger from '@docusaurus/logger';
 import readingTime from 'reading-time';
 import {
-  parseMarkdownString,
+  parseMarkdownFile,
   normalizeUrl,
   aliasedSitePath,
   getEditUrl,
@@ -29,7 +29,7 @@ import {
 } from '@docusaurus/utils';
 import {validateBlogPostFrontMatter} from './frontMatter';
 import {type AuthorsMap, getAuthorsMap, getBlogPostAuthors} from './authors';
-import type {LoadContext} from '@docusaurus/types';
+import type {LoadContext, ParseFrontMatter} from '@docusaurus/types';
 import type {
   PluginOptions,
   ReadingTimeFunction,
@@ -180,10 +180,19 @@ function formatBlogPostDate(
   }
 }
 
-async function parseBlogPostMarkdownFile(blogSourceAbsolute: string) {
-  const markdownString = await fs.readFile(blogSourceAbsolute, 'utf-8');
+async function parseBlogPostMarkdownFile({
+  filePath,
+  parseFrontMatter,
+}: {
+  filePath: string;
+  parseFrontMatter: ParseFrontMatter;
+}) {
+  const fileContent = await fs.readFile(filePath, 'utf-8');
   try {
-    const result = parseMarkdownString(markdownString, {
+    const result = await parseMarkdownFile({
+      filePath,
+      fileContent,
+      parseFrontMatter,
       removeContentTitle: true,
     });
     return {
@@ -191,7 +200,7 @@ async function parseBlogPostMarkdownFile(blogSourceAbsolute: string) {
       frontMatter: validateBlogPostFrontMatter(result.frontMatter),
     };
   } catch (err) {
-    logger.error`Error while parsing blog post file path=${blogSourceAbsolute}.`;
+    logger.error`Error while parsing blog post file path=${filePath}.`;
     throw err;
   }
 }
@@ -207,7 +216,10 @@ async function processBlogSourceFile(
   authorsMap?: AuthorsMap,
 ): Promise<BlogPost | undefined> {
   const {
-    siteConfig: {baseUrl},
+    siteConfig: {
+      baseUrl,
+      markdown: {parseFrontMatter},
+    },
     siteDir,
     i18n,
   } = context;
@@ -228,7 +240,10 @@ async function processBlogSourceFile(
   const blogSourceAbsolute = path.join(blogDirPath, blogSourceRelative);
 
   const {frontMatter, content, contentTitle, excerpt} =
-    await parseBlogPostMarkdownFile(blogSourceAbsolute);
+    await parseBlogPostMarkdownFile({
+      filePath: blogSourceAbsolute,
+      parseFrontMatter,
+    });
 
   const aliasedSource = aliasedSitePath(blogSourceAbsolute, siteDir);
 
@@ -319,7 +334,7 @@ async function processBlogSourceFile(
     routeBasePath,
     tagsRouteBasePath,
   ]);
-  const authors = getBlogPostAuthors({authorsMap, frontMatter});
+  const authors = getBlogPostAuthors({authorsMap, frontMatter, baseUrl});
 
   return {
     id: slug,