@docusaurus/plugin-content-pages 0.0.0-5600 → 0.0.0-5606

package/lib/frontMatter.d.ts

@@ -4,7 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { FrontMatter } from '@docusaurus/plugin-content-pages';
+import type { PageFrontMatter } from '@docusaurus/plugin-content-pages';
 export declare function validatePageFrontMatter(frontMatter: {
     [key: string]: unknown;
-}): FrontMatter;
+}): PageFrontMatter;

package/lib/frontMatter.js

@@ -9,8 +9,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.validatePageFrontMatter = void 0;
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const PageFrontMatterSchema = utils_validation_1.Joi.object({
-    title: utils_validation_1.Joi.string(),
-    description: utils_validation_1.Joi.string(),
+    // See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
+    title: utils_validation_1.Joi.string().allow(''),
+    // See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
+    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,
     wrapperClassName: utils_validation_1.Joi.string(),
     hide_table_of_contents: utils_validation_1.Joi.boolean(),
     ...utils_validation_1.FrontMatterTOCHeadingLevels,

package/lib/index.js

@@ -156,6 +156,11 @@ function pluginContentPages(context, options) {
                                             const aliasedSource = (0, utils_1.aliasedSitePath)(mdxPath, siteDir);
                                             return path_1.default.join(dataDir, `${(0, utils_1.docuHash)(aliasedSource)}.json`);
                                         },
+                                        // Assets allow to convert some relative images paths to
+                                        // require(...) calls
+                                        createAssets: ({ frontMatter, }) => ({
+                                            image: frontMatter.image,
+                                        }),
                                         markdownConfig: siteConfig.markdown,
                                     },
                                 },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-pages",
-  "version": "0.0.0-5600",
+  "version": "0.0.0-5606",
   "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": "0.0.0-5600",
-    "@docusaurus/mdx-loader": "0.0.0-5600",
-    "@docusaurus/types": "0.0.0-5600",
-    "@docusaurus/utils": "0.0.0-5600",
-    "@docusaurus/utils-validation": "0.0.0-5600",
+    "@docusaurus/core": "0.0.0-5606",
+    "@docusaurus/mdx-loader": "0.0.0-5606",
+    "@docusaurus/types": "0.0.0-5606",
+    "@docusaurus/utils": "0.0.0-5606",
+    "@docusaurus/utils-validation": "0.0.0-5606",
     "fs-extra": "^11.1.0",
     "tslib": "^2.5.0",
     "webpack": "^5.76.0"
@@ -34,5 +34,5 @@
   "engines": {
     "node": ">=16.14"
   },
-  "gitHead": "62f084dfadb259afeeb0fca09913a0b382d7d180"
+  "gitHead": "7d506f23e3d4600b0e85eac30bb59408a8d84ed5"
 }

package/src/frontMatter.ts

@@ -10,12 +10,17 @@ import {
   validateFrontMatter,
   FrontMatterTOCHeadingLevels,
   ContentVisibilitySchema,
+  URISchema,
 } from '@docusaurus/utils-validation';
-import type {FrontMatter} from '@docusaurus/plugin-content-pages';
+import type {PageFrontMatter} from '@docusaurus/plugin-content-pages';
 
-const PageFrontMatterSchema = Joi.object<FrontMatter>({
-  title: Joi.string(),
-  description: Joi.string(),
+const PageFrontMatterSchema = Joi.object<PageFrontMatter>({
+  // See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
+  title: Joi.string().allow(''),
+  // See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
+  description: Joi.string().allow(''),
+  keywords: Joi.array().items(Joi.string().required()),
+  image: URISchema,
   wrapperClassName: Joi.string(),
   hide_table_of_contents: Joi.boolean(),
   ...FrontMatterTOCHeadingLevels,
@@ -23,6 +28,6 @@ const PageFrontMatterSchema = Joi.object<FrontMatter>({
 
 export function validatePageFrontMatter(frontMatter: {
   [key: string]: unknown;
-}): FrontMatter {
+}): PageFrontMatter {
   return validateFrontMatter(frontMatter, PageFrontMatterSchema);
 }

package/src/index.ts

@@ -31,6 +31,7 @@ import type {
   PluginOptions,
   Metadata,
   LoadedContent,
+  PageFrontMatter,
 } from '@docusaurus/plugin-content-pages';
 
 export function getContentPathList(contentPaths: PagesContentPaths): string[] {
@@ -234,6 +235,15 @@ export default function pluginContentPages(
                         `${docuHash(aliasedSource)}.json`,
                       );
                     },
+                    // Assets allow to convert some relative images paths to
+                    // require(...) calls
+                    createAssets: ({
+                      frontMatter,
+                    }: {
+                      frontMatter: PageFrontMatter;
+                    }) => ({
+                      image: frontMatter.image,
+                    }),
                     markdownConfig: siteConfig.markdown,
                   },
                 },

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

@@ -9,6 +9,10 @@ declare module '@docusaurus/plugin-content-pages' {
   import type {MDXOptions} from '@docusaurus/mdx-loader';
   import type {LoadContext, Plugin} from '@docusaurus/types';
 
+  export type Assets = {
+    image?: string;
+  };
+
   export type PluginOptions = MDXOptions & {
     id?: string;
     path: string;
@@ -20,9 +24,11 @@ declare module '@docusaurus/plugin-content-pages' {
 
   export type Options = Partial<PluginOptions>;
 
-  export type FrontMatter = {
+  export type PageFrontMatter = {
     readonly title?: string;
     readonly description?: string;
+    readonly image?: string;
+    readonly keywords?: string[];
     readonly wrapperClassName?: string;
     readonly hide_table_of_contents?: string;
     readonly toc_min_heading_level?: number;
@@ -41,7 +47,7 @@ declare module '@docusaurus/plugin-content-pages' {
     type: 'mdx';
     permalink: string;
     source: string;
-    frontMatter: FrontMatter & {[key: string]: unknown};
+    frontMatter: PageFrontMatter & {[key: string]: unknown};
     title?: string;
     description?: string;
     unlisted: boolean;
@@ -61,11 +67,16 @@ declare module '@theme/MDXPage' {
   import type {LoadedMDXContent} from '@docusaurus/mdx-loader';
   import type {
     MDXPageMetadata,
-    FrontMatter,
+    PageFrontMatter,
+    Assets,
   } from '@docusaurus/plugin-content-pages';
 
   export interface Props {
-    readonly content: LoadedMDXContent<FrontMatter, MDXPageMetadata>;
+    readonly content: LoadedMDXContent<
+      PageFrontMatter,
+      MDXPageMetadata,
+      Assets
+    >;
   }
 
   export default function MDXPage(props: Props): JSX.Element;