@docusaurus/plugin-content-blog 2.0.0-beta.21 → 2.0.0-beta.22

package/lib/blogUtils.js

@@ -210,7 +210,7 @@ async function processBlogSourceFile(blogSourceRelative, contentPaths, context,
                     defaultReadingTime,
                 })
                 : undefined,
-            truncated: truncateMarker.test(content),
+            hasTruncateMarker: truncateMarker.test(content),
             authors,
             frontMatter,
         },

package/lib/index.js

@@ -9,25 +9,19 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateOptions = void 0;
 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 remark_admonitions_1 = tslib_1.__importDefault(require("remark-admonitions"));
 const blogUtils_1 = require("./blogUtils");
 const footnoteIDFixer_1 = tslib_1.__importDefault(require("./remark/footnoteIDFixer"));
 const translations_1 = require("./translations");
 const feed_1 = require("./feed");
 async function pluginContentBlog(context, options) {
-    if (options.admonitions) {
-        options.remarkPlugins = options.remarkPlugins.concat([
-            [remark_admonitions_1.default, options.admonitions],
-        ]);
-    }
-    const { siteDir, siteConfig, generatedFilesDir, i18n: { currentLocale }, } = context;
+    const { siteDir, siteConfig, generatedFilesDir, localizationDir, i18n: { currentLocale }, } = context;
     const { onBrokenMarkdownLinks, baseUrl } = siteConfig;
     const contentPaths = {
         contentPath: path_1.default.resolve(siteDir, options.path),
         contentPathLocalized: (0, utils_1.getPluginI18nPath)({
-            siteDir,
-            locale: currentLocale,
+            localizationDir,
             pluginName: 'docusaurus-plugin-content-blog',
             pluginId: options.id,
         }),
@@ -112,6 +106,20 @@ async function pluginContentBlog(context, options) {
             const sidebarBlogPosts = options.blogSidebarCount === 'ALL'
                 ? blogPosts
                 : blogPosts.slice(0, options.blogSidebarCount);
+            function blogPostItemsModule(items) {
+                return items.map((postId) => {
+                    const blogPostMetadata = blogItemsToMetadata[postId];
+                    return {
+                        content: {
+                            __import: true,
+                            path: blogPostMetadata.source,
+                            query: {
+                                truncated: true,
+                            },
+                        },
+                    };
+                });
+            }
             if (archiveBasePath && blogPosts.length) {
                 const archiveUrl = (0, utils_1.normalizeUrl)([
                     baseUrl,
@@ -169,15 +177,7 @@ async function pluginContentBlog(context, options) {
                     exact: true,
                     modules: {
                         sidebar: aliasedSource(sidebarProp),
-                        items: items.map((postID) => ({
-                            content: {
-                                __import: true,
-                                path: blogItemsToMetadata[postID].source,
-                                query: {
-                                    truncated: true,
-                                },
-                            },
-                        })),
+                        items: blogPostItemsModule(items),
                         metadata: aliasedSource(pageMetadataPath),
                     },
                 });
@@ -220,18 +220,7 @@ async function pluginContentBlog(context, options) {
                         exact: true,
                         modules: {
                             sidebar: aliasedSource(sidebarProp),
-                            items: items.map((postID) => {
-                                const blogPostMetadata = blogItemsToMetadata[postID];
-                                return {
-                                    content: {
-                                        __import: true,
-                                        path: blogPostMetadata.source,
-                                        query: {
-                                            truncated: true,
-                                        },
-                                    },
-                                };
-                            }),
+                            items: blogPostItemsModule(items),
                             tag: aliasedSource(tagPropPath),
                             listMetadata: aliasedSource(listMetadataPath),
                         },
@@ -245,7 +234,7 @@ async function pluginContentBlog(context, options) {
             return (0, translations_1.translateContent)(content, translationFiles);
         },
         configureWebpack(_config, isServer, { getJSLoader }, content) {
-            const { rehypePlugins, remarkPlugins, truncateMarker, beforeDefaultRemarkPlugins, beforeDefaultRehypePlugins, } = options;
+            const { admonitions, rehypePlugins, remarkPlugins, truncateMarker, beforeDefaultRemarkPlugins, beforeDefaultRehypePlugins, } = options;
             const markdownLoaderOptions = {
                 siteDir,
                 contentPaths,
@@ -255,7 +244,7 @@ async function pluginContentBlog(context, options) {
                     if (onBrokenMarkdownLinks === 'ignore') {
                         return;
                     }
-                    (0, utils_1.reportMessage)(`Blog markdown link couldn't be resolved: (${brokenMarkdownLink.link}) in ${brokenMarkdownLink.filePath}`, onBrokenMarkdownLinks);
+                    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);
@@ -277,6 +266,7 @@ async function pluginContentBlog(context, options) {
                                 {
                                     loader: require.resolve('@docusaurus/mdx-loader'),
                                     options: {
+                                        admonitions,
                                         remarkPlugins,
                                         rehypePlugins,
                                         beforeDefaultRemarkPlugins: [

package/lib/options.js

@@ -13,7 +13,7 @@ exports.DEFAULT_OPTIONS = {
     feedOptions: { type: ['rss', 'atom'], copyright: '' },
     beforeDefaultRehypePlugins: [],
     beforeDefaultRemarkPlugins: [],
-    admonitions: {},
+    admonitions: true,
     truncateMarker: /<!--\s*truncate\s*-->/,
     rehypePlugins: [],
     remarkPlugins: [],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "2.0.0-beta.21",
+  "version": "2.0.0-beta.22",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
@@ -18,22 +18,22 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.21",
-    "@docusaurus/logger": "2.0.0-beta.21",
-    "@docusaurus/mdx-loader": "2.0.0-beta.21",
-    "@docusaurus/utils": "2.0.0-beta.21",
-    "@docusaurus/utils-common": "2.0.0-beta.21",
-    "@docusaurus/utils-validation": "2.0.0-beta.21",
-    "cheerio": "^1.0.0-rc.11",
+    "@docusaurus/core": "2.0.0-beta.22",
+    "@docusaurus/logger": "2.0.0-beta.22",
+    "@docusaurus/mdx-loader": "2.0.0-beta.22",
+    "@docusaurus/types": "2.0.0-beta.22",
+    "@docusaurus/utils": "2.0.0-beta.22",
+    "@docusaurus/utils-common": "2.0.0-beta.22",
+    "@docusaurus/utils-validation": "2.0.0-beta.22",
+    "cheerio": "^1.0.0-rc.12",
     "feed": "^4.2.2",
     "fs-extra": "^10.1.0",
     "lodash": "^4.17.21",
     "reading-time": "^1.5.0",
-    "remark-admonitions": "^1.2.1",
     "tslib": "^2.4.0",
     "unist-util-visit": "^2.0.3",
     "utility-types": "^3.10.0",
-    "webpack": "^5.72.1"
+    "webpack": "^5.73.0"
   },
   "devDependencies": {
     "@docusaurus/types": "2.0.0-beta.21",
@@ -46,5 +46,5 @@
   "engines": {
     "node": ">=16.14"
   },
-  "gitHead": "69ac49fc6909517f13615ee40290c4bd00c39df4"
+  "gitHead": "daf9e462c4eebb7ac26a940932311f987e768f87"
 }

package/src/blogUtils.ts

@@ -323,7 +323,7 @@ async function processBlogSourceFile(
             defaultReadingTime,
           })
         : undefined,
-      truncated: truncateMarker.test(content),
+      hasTruncateMarker: truncateMarker.test(content),
       authors,
       frontMatter,
     },

package/src/index.ts

@@ -6,12 +6,12 @@
  */
 
 import path from 'path';
+import logger from '@docusaurus/logger';
 import {
   normalizeUrl,
   docuHash,
   aliasedSitePath,
   getPluginI18nPath,
-  reportMessage,
   posixPath,
   addTrailingPathSeparator,
   createAbsoluteFilePathMatcher,
@@ -21,7 +21,6 @@ import {
   type TagsListItem,
   type TagModule,
 } from '@docusaurus/utils';
-import admonitions from 'remark-admonitions';
 import {
   generateBlogPosts,
   getSourceToPermalink,
@@ -49,16 +48,11 @@ export default async function pluginContentBlog(
   context: LoadContext,
   options: PluginOptions,
 ): Promise<Plugin<BlogContent>> {
-  if (options.admonitions) {
-    options.remarkPlugins = options.remarkPlugins.concat([
-      [admonitions, options.admonitions],
-    ]);
-  }
-
   const {
     siteDir,
     siteConfig,
     generatedFilesDir,
+    localizationDir,
     i18n: {currentLocale},
   } = context;
   const {onBrokenMarkdownLinks, baseUrl} = siteConfig;
@@ -66,8 +60,7 @@ export default async function pluginContentBlog(
   const contentPaths: BlogContentPaths = {
     contentPath: path.resolve(siteDir, options.path),
     contentPathLocalized: getPluginI18nPath({
-      siteDir,
-      locale: currentLocale,
+      localizationDir,
       pluginName: 'docusaurus-plugin-content-blog',
       pluginId: options.id,
     }),
@@ -202,6 +195,21 @@ export default async function pluginContentBlog(
           ? blogPosts
           : blogPosts.slice(0, options.blogSidebarCount);
 
+      function blogPostItemsModule(items: string[]) {
+        return items.map((postId) => {
+          const blogPostMetadata = blogItemsToMetadata[postId]!;
+          return {
+            content: {
+              __import: true,
+              path: blogPostMetadata.source,
+              query: {
+                truncated: true,
+              },
+            },
+          };
+        });
+      }
+
       if (archiveBasePath && blogPosts.length) {
         const archiveUrl = normalizeUrl([
           baseUrl,
@@ -282,15 +290,7 @@ export default async function pluginContentBlog(
             exact: true,
             modules: {
               sidebar: aliasedSource(sidebarProp),
-              items: items.map((postID) => ({
-                content: {
-                  __import: true,
-                  path: blogItemsToMetadata[postID]!.source,
-                  query: {
-                    truncated: true,
-                  },
-                },
-              })),
+              items: blogPostItemsModule(items),
               metadata: aliasedSource(pageMetadataPath),
             },
           });
@@ -351,18 +351,7 @@ export default async function pluginContentBlog(
               exact: true,
               modules: {
                 sidebar: aliasedSource(sidebarProp),
-                items: items.map((postID) => {
-                  const blogPostMetadata = blogItemsToMetadata[postID]!;
-                  return {
-                    content: {
-                      __import: true,
-                      path: blogPostMetadata.source,
-                      query: {
-                        truncated: true,
-                      },
-                    },
-                  };
-                }),
+                items: blogPostItemsModule(items),
                 tag: aliasedSource(tagPropPath),
                 listMetadata: aliasedSource(listMetadataPath),
               },
@@ -381,6 +370,7 @@ export default async function pluginContentBlog(
 
     configureWebpack(_config, isServer, {getJSLoader}, content) {
       const {
+        admonitions,
         rehypePlugins,
         remarkPlugins,
         truncateMarker,
@@ -397,10 +387,9 @@ export default async function pluginContentBlog(
           if (onBrokenMarkdownLinks === 'ignore') {
             return;
           }
-          reportMessage(
-            `Blog markdown link couldn't be resolved: (${brokenMarkdownLink.link}) in ${brokenMarkdownLink.filePath}`,
+          logger.report(
             onBrokenMarkdownLinks,
-          );
+          )`Blog markdown link couldn't be resolved: (url=${brokenMarkdownLink.link}) in path=${brokenMarkdownLink.filePath}`;
         },
       };
 
@@ -423,6 +412,7 @@ export default async function pluginContentBlog(
                 {
                   loader: require.resolve('@docusaurus/mdx-loader'),
                   options: {
+                    admonitions,
                     remarkPlugins,
                     rehypePlugins,
                     beforeDefaultRemarkPlugins: [

package/src/options.ts

@@ -24,7 +24,7 @@ export const DEFAULT_OPTIONS: PluginOptions = {
   feedOptions: {type: ['rss', 'atom'], copyright: ''},
   beforeDefaultRehypePlugins: [],
   beforeDefaultRemarkPlugins: [],
-  admonitions: {},
+  admonitions: true,
   truncateMarker: /<!--\s*truncate\s*-->/,
   rehypePlugins: [],
   remarkPlugins: [],

package/src/plugin-content-blog.d.ts

@@ -6,6 +6,7 @@
  */
 
 declare module '@docusaurus/plugin-content-blog' {
+  import type {LoadedMDXContent} from '@docusaurus/mdx-loader';
   import type {MDXOptions} from '@docusaurus/mdx-loader';
   import type {FrontMatterTag, Tag} from '@docusaurus/utils';
   import type {Plugin, LoadContext} from '@docusaurus/types';
@@ -201,7 +202,7 @@ declare module '@docusaurus/plugin-content-blog' {
     /**
      * Whether the truncate marker exists in the post's content.
      */
-    readonly truncated?: boolean;
+    readonly hasTruncateMarker: boolean;
     /**
      * Used in pagination. Generated after the other metadata, so not readonly.
      * Content is just a subset of another post's metadata.
@@ -377,7 +378,6 @@ declare module '@docusaurus/plugin-content-blog' {
      * unlocalized file. Ignored when `editUrl` is a function.
      */
     editLocalizedFiles?: boolean;
-    admonitions: {[key: string]: unknown};
     /** Path to the authors map file, relative to the blog content directory. */
     authorsMapPath: string;
     /** A callback to customize the reading time number displayed. */
@@ -463,6 +463,20 @@ declare module '@docusaurus/plugin-content-blog' {
     items: string[];
   };
 
+  type PropBlogPostMetadata = Overwrite<
+    BlogPostMetadata,
+    {
+      /** The publish date of the post. Serialized from the `Date` object. */
+      date: string;
+    }
+  >;
+
+  export type PropBlogPostContent = LoadedMDXContent<
+    BlogPostFrontMatter,
+    PropBlogPostMetadata,
+    Assets
+  >;
+
   export default function pluginContentBlog(
     context: LoadContext,
     options: PluginOptions,
@@ -470,26 +484,15 @@ declare module '@docusaurus/plugin-content-blog' {
 }
 
 declare module '@theme/BlogPostPage' {
-  import type {LoadedMDXContent} from '@docusaurus/mdx-loader';
   import type {
     BlogPostFrontMatter,
-    BlogPostMetadata,
-    Assets,
     BlogSidebar,
+    PropBlogPostContent,
   } from '@docusaurus/plugin-content-blog';
-  import type {Overwrite} from 'utility-types';
 
   export type FrontMatter = BlogPostFrontMatter;
 
-  export type Metadata = Overwrite<
-    BlogPostMetadata,
-    {
-      /** The publish date of the post. Serialized from the `Date` object. */
-      date: string;
-    }
-  >;
-
-  export type Content = LoadedMDXContent<FrontMatter, Metadata, Assets>;
+  export type Content = PropBlogPostContent;
 
   export interface Props {
     /** Blog sidebar. */
@@ -501,6 +504,10 @@ declare module '@theme/BlogPostPage' {
   export default function BlogPostPage(props: Props): JSX.Element;
 }
 
+declare module '@theme/BlogPostPage/Metadata' {
+  export default function BlogPostPageMetadata(): JSX.Element;
+}
+
 declare module '@theme/BlogListPage' {
   import type {Content} from '@theme/BlogPostPage';
   import type {

package/src/deps.d.ts

@@ -1,13 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-declare module 'remark-admonitions' {
-  type Options = {[key: string]: unknown};
-
-  const plugin: (options?: Options) => void;
-  export = plugin;
-}