@docusaurus/plugin-content-pages 3.7.0 → 3.8.0

package/lib/content.js

@@ -55,12 +55,11 @@ async function processPageSourceFile(relativeSource, params) {
     const contentPath = await (0, utils_1.getFolderContainingFile)(getContentPathList(contentPaths), relativeSource);
     const source = path_1.default.join(contentPath, relativeSource);
     const aliasedSourcePath = (0, utils_1.aliasedSitePath)(source, siteDir);
-    const permalink = (0, utils_1.normalizeUrl)([
-        baseUrl,
-        options.routeBasePath,
-        (0, utils_1.encodePath)((0, utils_1.fileToPath)(relativeSource)),
-    ]);
+    const filenameSlug = (0, utils_1.encodePath)((0, utils_1.fileToPath)(relativeSource));
     if (!isMarkdownSource(relativeSource)) {
+        // For now, slug can't be customized for JSX pages
+        const slug = filenameSlug;
+        const permalink = (0, utils_1.normalizeUrl)([baseUrl, options.routeBasePath, slug]);
         return {
             type: 'jsx',
             permalink,
@@ -74,6 +73,8 @@ async function processPageSourceFile(relativeSource, params) {
         parseFrontMatter: siteConfig.markdown.parseFrontMatter,
     });
     const frontMatter = (0, frontMatter_1.validatePageFrontMatter)(unsafeFrontMatter);
+    const slug = frontMatter.slug ?? filenameSlug;
+    const permalink = (0, utils_1.normalizeUrl)([baseUrl, options.routeBasePath, slug]);
     const pagesDirPath = await (0, utils_1.getFolderContainingFile)(getContentPathList(contentPaths), relativeSource);
     const pagesSourceAbsolute = path_1.default.join(pagesDirPath, relativeSource);
     function getPagesEditUrl() {

package/lib/frontMatter.js

@@ -15,6 +15,7 @@ const PageFrontMatterSchema = utils_validation_1.Joi.object({
     description: utils_validation_1.Joi.string().allow(''),
     keywords: utils_validation_1.Joi.array().items(utils_validation_1.Joi.string().required()),
     image: utils_validation_1.URISchema,
+    slug: utils_validation_1.Joi.string(),
     wrapperClassName: utils_validation_1.Joi.string(),
     hide_table_of_contents: utils_validation_1.Joi.boolean(),
     ...utils_validation_1.FrontMatterTOCHeadingLevels,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-pages",
-  "version": "3.7.0",
+  "version": "3.8.0",
   "description": "Pages plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-pages.d.ts",
@@ -18,11 +18,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "3.7.0",
-    "@docusaurus/mdx-loader": "3.7.0",
-    "@docusaurus/types": "3.7.0",
-    "@docusaurus/utils": "3.7.0",
-    "@docusaurus/utils-validation": "3.7.0",
+    "@docusaurus/core": "3.8.0",
+    "@docusaurus/mdx-loader": "3.8.0",
+    "@docusaurus/types": "3.8.0",
+    "@docusaurus/utils": "3.8.0",
+    "@docusaurus/utils-validation": "3.8.0",
     "fs-extra": "^11.1.1",
     "tslib": "^2.6.0",
     "webpack": "^5.88.1"
@@ -34,5 +34,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "dd59750c16fe6908a26f18806a54d4c3dbe6db43"
+  "gitHead": "948d63c42fad0ba24b7b531a9deb6167e64dc845"
 }

package/src/content.ts

@@ -106,12 +106,13 @@ async function processPageSourceFile(
 
   const source = path.join(contentPath, relativeSource);
   const aliasedSourcePath = aliasedSitePath(source, siteDir);
-  const permalink = normalizeUrl([
-    baseUrl,
-    options.routeBasePath,
-    encodePath(fileToPath(relativeSource)),
-  ]);
+
+  const filenameSlug = encodePath(fileToPath(relativeSource));
+
   if (!isMarkdownSource(relativeSource)) {
+    // For now, slug can't be customized for JSX pages
+    const slug = filenameSlug;
+    const permalink = normalizeUrl([baseUrl, options.routeBasePath, slug]);
     return {
       type: 'jsx',
       permalink,
@@ -131,6 +132,9 @@ async function processPageSourceFile(
   });
   const frontMatter = validatePageFrontMatter(unsafeFrontMatter);
 
+  const slug = frontMatter.slug ?? filenameSlug;
+  const permalink = normalizeUrl([baseUrl, options.routeBasePath, slug]);
+
   const pagesDirPath = await getFolderContainingFile(
     getContentPathList(contentPaths),
     relativeSource,

package/src/frontMatter.ts

@@ -22,6 +22,7 @@ const PageFrontMatterSchema = Joi.object<PageFrontMatter>({
   description: Joi.string().allow(''),
   keywords: Joi.array().items(Joi.string().required()),
   image: URISchema,
+  slug: Joi.string(),
   wrapperClassName: Joi.string(),
   hide_table_of_contents: Joi.boolean(),
   ...FrontMatterTOCHeadingLevels,

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

@@ -7,7 +7,11 @@
 
 declare module '@docusaurus/plugin-content-pages' {
   import type {MDXOptions} from '@docusaurus/mdx-loader';
-  import type {LoadContext, Plugin} from '@docusaurus/types';
+  import type {
+    LoadContext,
+    Plugin,
+    OptionValidationContext,
+  } from '@docusaurus/types';
   import type {FrontMatterLastUpdate, LastUpdateData} from '@docusaurus/utils';
 
   export type Assets = {
@@ -33,6 +37,7 @@ declare module '@docusaurus/plugin-content-pages' {
     readonly title?: string;
     readonly description?: string;
     readonly image?: string;
+    readonly slug?: string;
     readonly keywords?: string[];
     readonly wrapperClassName?: string;
     readonly hide_table_of_contents?: string;
@@ -82,6 +87,10 @@ declare module '@docusaurus/plugin-content-pages' {
     context: LoadContext,
     options: PluginOptions,
   ): Promise<Plugin<LoadedContent | null>>;
+
+  export function validateOptions(
+    args: OptionValidationContext<Options | undefined, PluginOptions>,
+  ): PluginOptions;
 }
 
 declare module '@theme/MDXPage' {