@docusaurus/plugin-content-blog 0.0.0-5828 → 0.0.0-5831

package/lib/blogUtils.d.ts

@@ -11,12 +11,13 @@ export declare function truncate(fileString: string, truncateMarker: RegExp): st
 export declare function getSourceToPermalink(blogPosts: BlogPost[]): {
     [aliasedPath: string]: string;
 };
-export declare function paginateBlogPosts({ blogPosts, basePageUrl, blogTitle, blogDescription, postsPerPageOption, }: {
+export declare function paginateBlogPosts({ blogPosts, basePageUrl, blogTitle, blogDescription, postsPerPageOption, pageBasePath, }: {
     blogPosts: BlogPost[];
     basePageUrl: string;
     blogTitle: string;
     blogDescription: string;
     postsPerPageOption: number | 'ALL';
+    pageBasePath: string;
 }): BlogPaginated[];
 export declare function shouldBeListed(blogPost: BlogPost): boolean;
 export declare function getBlogTags({ blogPosts, ...params }: {
@@ -24,6 +25,7 @@ export declare function getBlogTags({ blogPosts, ...params }: {
     blogTitle: string;
     blogDescription: string;
     postsPerPageOption: number | 'ALL';
+    pageBasePath: string;
 }): BlogTags;
 type ParsedBlogFileName = {
     date: Date | undefined;

package/lib/blogUtils.js

@@ -24,14 +24,14 @@ function getSourceToPermalink(blogPosts) {
     return Object.fromEntries(blogPosts.map(({ metadata: { source, permalink } }) => [source, permalink]));
 }
 exports.getSourceToPermalink = getSourceToPermalink;
-function paginateBlogPosts({ blogPosts, basePageUrl, blogTitle, blogDescription, postsPerPageOption, }) {
+function paginateBlogPosts({ blogPosts, basePageUrl, blogTitle, blogDescription, postsPerPageOption, pageBasePath, }) {
     const totalCount = blogPosts.length;
     const postsPerPage = postsPerPageOption === 'ALL' ? totalCount : postsPerPageOption;
     const numberOfPages = Math.ceil(totalCount / postsPerPage);
     const pages = [];
     function permalink(page) {
         return page > 0
-            ? (0, utils_1.normalizeUrl)([basePageUrl, `page/${page + 1}`])
+            ? (0, utils_1.normalizeUrl)([basePageUrl, pageBasePath, `${page + 1}`])
             : basePageUrl;
     }
     for (let page = 0; page < numberOfPages; page += 1) {

package/lib/index.js

@@ -47,7 +47,7 @@ async function pluginContentBlog(context, options) {
         },
         // Fetches blog contents and returns metadata for the necessary routes.
         async loadContent() {
-            const { postsPerPage: postsPerPageOption, routeBasePath, tagsBasePath, blogDescription, blogTitle, blogSidebarTitle, } = options;
+            const { postsPerPage: postsPerPageOption, routeBasePath, tagsBasePath, blogDescription, blogTitle, blogSidebarTitle, pageBasePath, } = options;
             const baseBlogUrl = (0, utils_1.normalizeUrl)([baseUrl, routeBasePath]);
             const blogTagsListPath = (0, utils_1.normalizeUrl)([baseBlogUrl, tagsBasePath]);
             const blogPosts = await (0, blogUtils_1.generateBlogPosts)(contentPaths, context, options);
@@ -59,10 +59,9 @@ async function pluginContentBlog(context, options) {
                     blogListPaginated: [],
                     blogTags: {},
                     blogTagsListPath,
-                    blogTagsPaginated: [],
                 };
             }
-            // Colocate next and prev metadata.
+            // Collocate next and prev metadata.
             listedBlogPosts.forEach((blogPost, index) => {
                 const prevItem = index > 0 ? listedBlogPosts[index - 1] : null;
                 if (prevItem) {
@@ -87,12 +86,14 @@ async function pluginContentBlog(context, options) {
                 blogDescription,
                 postsPerPageOption,
                 basePageUrl: baseBlogUrl,
+                pageBasePath,
             });
             const blogTags = (0, blogUtils_1.getBlogTags)({
                 blogPosts,
                 postsPerPageOption,
                 blogDescription,
                 blogTitle,
+                pageBasePath,
             });
             return {
                 blogSidebarTitle,

package/lib/options.js

@@ -33,6 +33,7 @@ exports.DEFAULT_OPTIONS = {
     routeBasePath: 'blog',
     tagsBasePath: 'tags',
     archiveBasePath: 'archive',
+    pageBasePath: 'page',
     path: 'blog',
     editLocalizedFiles: false,
     authorsMapPath: 'authors.yml',
@@ -46,6 +47,7 @@ const PluginOptionSchema = utils_validation_1.Joi.object({
         .allow(null),
     routeBasePath: utils_validation_1.RouteBasePathSchema.default(exports.DEFAULT_OPTIONS.routeBasePath),
     tagsBasePath: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.tagsBasePath),
+    pageBasePath: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.pageBasePath),
     include: utils_validation_1.Joi.array().items(utils_validation_1.Joi.string()).default(exports.DEFAULT_OPTIONS.include),
     exclude: utils_validation_1.Joi.array().items(utils_validation_1.Joi.string()).default(exports.DEFAULT_OPTIONS.exclude),
     postsPerPage: utils_validation_1.Joi.alternatives()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "0.0.0-5828",
+  "version": "0.0.0-5831",
   "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": "0.0.0-5828",
-    "@docusaurus/logger": "0.0.0-5828",
-    "@docusaurus/mdx-loader": "0.0.0-5828",
-    "@docusaurus/types": "0.0.0-5828",
-    "@docusaurus/utils": "0.0.0-5828",
-    "@docusaurus/utils-common": "0.0.0-5828",
-    "@docusaurus/utils-validation": "0.0.0-5828",
+    "@docusaurus/core": "0.0.0-5831",
+    "@docusaurus/logger": "0.0.0-5831",
+    "@docusaurus/mdx-loader": "0.0.0-5831",
+    "@docusaurus/types": "0.0.0-5831",
+    "@docusaurus/utils": "0.0.0-5831",
+    "@docusaurus/utils-common": "0.0.0-5831",
+    "@docusaurus/utils-validation": "0.0.0-5831",
     "cheerio": "^1.0.0-rc.12",
     "feed": "^4.2.2",
     "fs-extra": "^11.1.1",
@@ -44,5 +44,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "16fd157785a56e88f361f7ff8667c18511dc0a1b"
+  "gitHead": "ae029ea17949629c9ab651e035696f21660b0330"
 }

package/src/blogUtils.ts

@@ -57,12 +57,14 @@ export function paginateBlogPosts({
   blogTitle,
   blogDescription,
   postsPerPageOption,
+  pageBasePath,
 }: {
   blogPosts: BlogPost[];
   basePageUrl: string;
   blogTitle: string;
   blogDescription: string;
   postsPerPageOption: number | 'ALL';
+  pageBasePath: string;
 }): BlogPaginated[] {
   const totalCount = blogPosts.length;
   const postsPerPage =
@@ -73,7 +75,7 @@ export function paginateBlogPosts({
 
   function permalink(page: number) {
     return page > 0
-      ? normalizeUrl([basePageUrl, `page/${page + 1}`])
+      ? normalizeUrl([basePageUrl, pageBasePath, `${page + 1}`])
       : basePageUrl;
   }
 
@@ -111,6 +113,7 @@ export function getBlogTags({
   blogTitle: string;
   blogDescription: string;
   postsPerPageOption: number | 'ALL';
+  pageBasePath: string;
 }): BlogTags {
   const groups = groupTaggedItems(
     blogPosts,

package/src/index.ts

@@ -107,6 +107,7 @@ export default async function pluginContentBlog(
         blogDescription,
         blogTitle,
         blogSidebarTitle,
+        pageBasePath,
       } = options;
 
       const baseBlogUrl = normalizeUrl([baseUrl, routeBasePath]);
@@ -121,11 +122,10 @@ export default async function pluginContentBlog(
           blogListPaginated: [],
           blogTags: {},
           blogTagsListPath,
-          blogTagsPaginated: [],
         };
       }
 
-      // Colocate next and prev metadata.
+      // Collocate next and prev metadata.
       listedBlogPosts.forEach((blogPost, index) => {
         const prevItem = index > 0 ? listedBlogPosts[index - 1] : null;
         if (prevItem) {
@@ -153,6 +153,7 @@ export default async function pluginContentBlog(
         blogDescription,
         postsPerPageOption,
         basePageUrl: baseBlogUrl,
+        pageBasePath,
       });
 
       const blogTags: BlogTags = getBlogTags({
@@ -160,6 +161,7 @@ export default async function pluginContentBlog(
         postsPerPageOption,
         blogDescription,
         blogTitle,
+        pageBasePath,
       });
 
       return {

package/src/options.ts

@@ -45,6 +45,7 @@ export const DEFAULT_OPTIONS: PluginOptions = {
   routeBasePath: 'blog',
   tagsBasePath: 'tags',
   archiveBasePath: 'archive',
+  pageBasePath: 'page',
   path: 'blog',
   editLocalizedFiles: false,
   authorsMapPath: 'authors.yml',
@@ -59,6 +60,7 @@ const PluginOptionSchema = Joi.object<PluginOptions>({
     .allow(null),
   routeBasePath: RouteBasePathSchema.default(DEFAULT_OPTIONS.routeBasePath),
   tagsBasePath: Joi.string().default(DEFAULT_OPTIONS.tagsBasePath),
+  pageBasePath: Joi.string().default(DEFAULT_OPTIONS.pageBasePath),
   include: Joi.array().items(Joi.string()).default(DEFAULT_OPTIONS.include),
   exclude: Joi.array().items(Joi.string()).default(DEFAULT_OPTIONS.exclude),
   postsPerPage: Joi.alternatives()

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

@@ -351,9 +351,14 @@ yarn workspace v1.22.19image` is a collocated image path, this entry will be the
     routeBasePath: string;
     /**
      * URL route for the tags section of your blog. Will be appended to
-     * `routeBasePath`. **DO NOT** include a trailing slash.
+     * `routeBasePath`.
      */
     tagsBasePath: string;
+    /**
+     * URL route for the pages section of your blog. Will be appended to
+     * `routeBasePath`.
+     */
+    pageBasePath: string;
     /**
      * URL route for the archive section of your blog. Will be appended to
      * `routeBasePath`. **DO NOT** include a trailing slash. Use `null` to