@docusaurus/plugin-content-pages 0.0.0-5894 → 0.0.0-5899

package/lib/frontMatter.js

@@ -18,6 +18,7 @@ const PageFrontMatterSchema = utils_validation_1.Joi.object({
     wrapperClassName: utils_validation_1.Joi.string(),
     hide_table_of_contents: utils_validation_1.Joi.boolean(),
     ...utils_validation_1.FrontMatterTOCHeadingLevels,
+    last_update: utils_validation_1.FrontMatterLastUpdateSchema,
 }).concat(utils_validation_1.ContentVisibilitySchema);
 function validatePageFrontMatter(frontMatter) {
     return (0, utils_validation_1.validateFrontMatter)(frontMatter, PageFrontMatterSchema);

package/lib/index.js

@@ -18,7 +18,7 @@ function getContentPathList(contentPaths) {
 exports.getContentPathList = getContentPathList;
 const isMarkdownSource = (source) => source.endsWith('.md') || source.endsWith('.mdx');
 function pluginContentPages(context, options) {
-    const { siteConfig, siteDir, generatedFilesDir, localizationDir } = context;
+    const { siteConfig, siteDir, generatedFilesDir, localizationDir, i18n } = context;
     const contentPaths = {
         contentPath: path_1.default.resolve(siteDir, options.path),
         contentPathLocalized: (0, utils_1.getPluginI18nPath)({
@@ -36,7 +36,7 @@ function pluginContentPages(context, options) {
             return getContentPathList(contentPaths).flatMap((contentPath) => include.map((pattern) => `${contentPath}/${pattern}`));
         },
         async loadContent() {
-            const { include } = options;
+            const { include, editUrl } = options;
             if (!(await fs_extra_1.default.pathExists(contentPaths.contentPath))) {
                 return null;
             }
@@ -69,6 +69,32 @@ function pluginContentPages(context, options) {
                     parseFrontMatter: siteConfig.markdown.parseFrontMatter,
                 });
                 const frontMatter = (0, frontMatter_1.validatePageFrontMatter)(unsafeFrontMatter);
+                const pagesDirPath = await (0, utils_1.getFolderContainingFile)(getContentPathList(contentPaths), relativeSource);
+                const pagesSourceAbsolute = path_1.default.join(pagesDirPath, relativeSource);
+                function getPagesEditUrl() {
+                    const pagesPathRelative = path_1.default.relative(pagesDirPath, path_1.default.resolve(pagesSourceAbsolute));
+                    if (typeof editUrl === 'function') {
+                        return editUrl({
+                            pagesDirPath: (0, utils_1.posixPath)(path_1.default.relative(siteDir, pagesDirPath)),
+                            pagesPath: (0, utils_1.posixPath)(pagesPathRelative),
+                            permalink,
+                            locale: i18n.currentLocale,
+                        });
+                    }
+                    else if (typeof editUrl === 'string') {
+                        const isLocalized = pagesDirPath === contentPaths.contentPathLocalized;
+                        const fileContentPath = isLocalized && options.editLocalizedFiles
+                            ? contentPaths.contentPathLocalized
+                            : contentPaths.contentPath;
+                        const contentPathEditUrl = (0, utils_1.normalizeUrl)([
+                            editUrl,
+                            (0, utils_1.posixPath)(path_1.default.relative(siteDir, fileContentPath)),
+                        ]);
+                        return (0, utils_1.getEditUrl)(pagesPathRelative, contentPathEditUrl);
+                    }
+                    return undefined;
+                }
+                const lastUpdatedData = await (0, utils_1.readLastUpdateData)(source, options, frontMatter.last_update);
                 if ((0, utils_1.isDraft)({ frontMatter })) {
                     return undefined;
                 }
@@ -80,6 +106,9 @@ function pluginContentPages(context, options) {
                     title: frontMatter.title ?? contentTitle,
                     description: frontMatter.description ?? excerpt,
                     frontMatter,
+                    lastUpdatedBy: lastUpdatedData.lastUpdatedBy,
+                    lastUpdatedAt: lastUpdatedData.lastUpdatedAt,
+                    editUrl: getPagesEditUrl(),
                     unlisted,
                 };
             }
@@ -99,12 +128,10 @@ function pluginContentPages(context, options) {
             }
             const { addRoute, createData } = actions;
             function createPageRouteMetadata(metadata) {
+                const lastUpdatedAt = metadata.type === 'mdx' ? metadata.lastUpdatedAt : undefined;
                 return {
                     sourceFilePath: (0, utils_1.aliasedSitePathToRelativePath)(metadata.source),
-                    // TODO add support for last updated date in the page plugin
-                    //  at least for Markdown files
-                    // lastUpdatedAt: metadata.lastUpdatedAt,
-                    lastUpdatedAt: undefined,
+                    lastUpdatedAt,
                 };
             }
             await Promise.all(content.map(async (metadata) => {

package/lib/options.js

@@ -20,6 +20,9 @@ exports.DEFAULT_OPTIONS = {
     beforeDefaultRehypePlugins: [],
     beforeDefaultRemarkPlugins: [],
     admonitions: true,
+    showLastUpdateTime: false,
+    showLastUpdateAuthor: false,
+    editLocalizedFiles: false,
 };
 const PluginOptionSchema = utils_validation_1.Joi.object({
     path: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.path),
@@ -32,6 +35,10 @@ const PluginOptionSchema = utils_validation_1.Joi.object({
     beforeDefaultRehypePlugins: utils_validation_1.RehypePluginsSchema.default(exports.DEFAULT_OPTIONS.beforeDefaultRehypePlugins),
     beforeDefaultRemarkPlugins: utils_validation_1.RemarkPluginsSchema.default(exports.DEFAULT_OPTIONS.beforeDefaultRemarkPlugins),
     admonitions: utils_validation_1.AdmonitionsSchema.default(exports.DEFAULT_OPTIONS.admonitions),
+    showLastUpdateTime: utils_validation_1.Joi.bool().default(exports.DEFAULT_OPTIONS.showLastUpdateTime),
+    showLastUpdateAuthor: utils_validation_1.Joi.bool().default(exports.DEFAULT_OPTIONS.showLastUpdateAuthor),
+    editUrl: utils_validation_1.Joi.alternatives().try(utils_validation_1.URISchema, utils_validation_1.Joi.function()),
+    editLocalizedFiles: utils_validation_1.Joi.boolean().default(exports.DEFAULT_OPTIONS.editLocalizedFiles),
 });
 function validateOptions({ validate, options, }) {
     const validatedOptions = validate(PluginOptionSchema, options);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-pages",
-  "version": "0.0.0-5894",
+  "version": "0.0.0-5899",
   "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-5894",
-    "@docusaurus/mdx-loader": "0.0.0-5894",
-    "@docusaurus/types": "0.0.0-5894",
-    "@docusaurus/utils": "0.0.0-5894",
-    "@docusaurus/utils-validation": "0.0.0-5894",
+    "@docusaurus/core": "0.0.0-5899",
+    "@docusaurus/mdx-loader": "0.0.0-5899",
+    "@docusaurus/types": "0.0.0-5899",
+    "@docusaurus/utils": "0.0.0-5899",
+    "@docusaurus/utils-validation": "0.0.0-5899",
     "fs-extra": "^11.1.1",
     "tslib": "^2.6.0",
     "webpack": "^5.88.1"
@@ -34,5 +34,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "002e325935f110e1f4142478b71b62ba21318bd5"
+  "gitHead": "e8e1f914293e8dade7f4e0907d9a00bd1df80470"
 }

package/src/frontMatter.ts

@@ -11,6 +11,7 @@ import {
   FrontMatterTOCHeadingLevels,
   ContentVisibilitySchema,
   URISchema,
+  FrontMatterLastUpdateSchema,
 } from '@docusaurus/utils-validation';
 import type {PageFrontMatter} from '@docusaurus/plugin-content-pages';
 
@@ -24,6 +25,7 @@ const PageFrontMatterSchema = Joi.object<PageFrontMatter>({
   wrapperClassName: Joi.string(),
   hide_table_of_contents: Joi.boolean(),
   ...FrontMatterTOCHeadingLevels,
+  last_update: FrontMatterLastUpdateSchema,
 }).concat(ContentVisibilitySchema);
 
 export function validatePageFrontMatter(frontMatter: {

package/src/index.ts

@@ -23,6 +23,9 @@ import {
   parseMarkdownFile,
   isUnlisted,
   isDraft,
+  readLastUpdateData,
+  getEditUrl,
+  posixPath,
 } from '@docusaurus/utils';
 import {validatePageFrontMatter} from './frontMatter';
 import type {LoadContext, Plugin, RouteMetadata} from '@docusaurus/types';
@@ -45,7 +48,8 @@ export default function pluginContentPages(
   context: LoadContext,
   options: PluginOptions,
 ): Plugin<LoadedContent | null> {
-  const {siteConfig, siteDir, generatedFilesDir, localizationDir} = context;
+  const {siteConfig, siteDir, generatedFilesDir, localizationDir, i18n} =
+    context;
 
   const contentPaths: PagesContentPaths = {
     contentPath: path.resolve(siteDir, options.path),
@@ -73,7 +77,7 @@ export default function pluginContentPages(
     },
 
     async loadContent() {
-      const {include} = options;
+      const {include, editUrl} = options;
 
       if (!(await fs.pathExists(contentPaths.contentPath))) {
         return null;
@@ -120,6 +124,50 @@ export default function pluginContentPages(
         });
         const frontMatter = validatePageFrontMatter(unsafeFrontMatter);
 
+        const pagesDirPath = await getFolderContainingFile(
+          getContentPathList(contentPaths),
+          relativeSource,
+        );
+
+        const pagesSourceAbsolute = path.join(pagesDirPath, relativeSource);
+
+        function getPagesEditUrl() {
+          const pagesPathRelative = path.relative(
+            pagesDirPath,
+            path.resolve(pagesSourceAbsolute),
+          );
+
+          if (typeof editUrl === 'function') {
+            return editUrl({
+              pagesDirPath: posixPath(path.relative(siteDir, pagesDirPath)),
+              pagesPath: posixPath(pagesPathRelative),
+              permalink,
+              locale: i18n.currentLocale,
+            });
+          } else if (typeof editUrl === 'string') {
+            const isLocalized =
+              pagesDirPath === contentPaths.contentPathLocalized;
+            const fileContentPath =
+              isLocalized && options.editLocalizedFiles
+                ? contentPaths.contentPathLocalized
+                : contentPaths.contentPath;
+
+            const contentPathEditUrl = normalizeUrl([
+              editUrl,
+              posixPath(path.relative(siteDir, fileContentPath)),
+            ]);
+
+            return getEditUrl(pagesPathRelative, contentPathEditUrl);
+          }
+          return undefined;
+        }
+
+        const lastUpdatedData = await readLastUpdateData(
+          source,
+          options,
+          frontMatter.last_update,
+        );
+
         if (isDraft({frontMatter})) {
           return undefined;
         }
@@ -132,6 +180,9 @@ export default function pluginContentPages(
           title: frontMatter.title ?? contentTitle,
           description: frontMatter.description ?? excerpt,
           frontMatter,
+          lastUpdatedBy: lastUpdatedData.lastUpdatedBy,
+          lastUpdatedAt: lastUpdatedData.lastUpdatedAt,
+          editUrl: getPagesEditUrl(),
           unlisted,
         };
       }
@@ -160,12 +211,12 @@ export default function pluginContentPages(
       const {addRoute, createData} = actions;
 
       function createPageRouteMetadata(metadata: Metadata): RouteMetadata {
+        const lastUpdatedAt =
+          metadata.type === 'mdx' ? metadata.lastUpdatedAt : undefined;
+
         return {
           sourceFilePath: aliasedSitePathToRelativePath(metadata.source),
-          // TODO add support for last updated date in the page plugin
-          //  at least for Markdown files
-          // lastUpdatedAt: metadata.lastUpdatedAt,
-          lastUpdatedAt: undefined,
+          lastUpdatedAt,
         };
       }
 

package/src/options.ts

@@ -11,6 +11,7 @@ import {
   RehypePluginsSchema,
   AdmonitionsSchema,
   RouteBasePathSchema,
+  URISchema,
 } from '@docusaurus/utils-validation';
 import {GlobExcludeDefault} from '@docusaurus/utils';
 import type {OptionValidationContext} from '@docusaurus/types';
@@ -27,6 +28,9 @@ export const DEFAULT_OPTIONS: PluginOptions = {
   beforeDefaultRehypePlugins: [],
   beforeDefaultRemarkPlugins: [],
   admonitions: true,
+  showLastUpdateTime: false,
+  showLastUpdateAuthor: false,
+  editLocalizedFiles: false,
 };
 
 const PluginOptionSchema = Joi.object<PluginOptions>({
@@ -44,6 +48,12 @@ const PluginOptionSchema = Joi.object<PluginOptions>({
     DEFAULT_OPTIONS.beforeDefaultRemarkPlugins,
   ),
   admonitions: AdmonitionsSchema.default(DEFAULT_OPTIONS.admonitions),
+  showLastUpdateTime: Joi.bool().default(DEFAULT_OPTIONS.showLastUpdateTime),
+  showLastUpdateAuthor: Joi.bool().default(
+    DEFAULT_OPTIONS.showLastUpdateAuthor,
+  ),
+  editUrl: Joi.alternatives().try(URISchema, Joi.function()),
+  editLocalizedFiles: Joi.boolean().default(DEFAULT_OPTIONS.editLocalizedFiles),
 });
 
 export function validateOptions({

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

@@ -8,6 +8,7 @@
 declare module '@docusaurus/plugin-content-pages' {
   import type {MDXOptions} from '@docusaurus/mdx-loader';
   import type {LoadContext, Plugin} from '@docusaurus/types';
+  import type {FrontMatterLastUpdate, LastUpdateData} from '@docusaurus/utils';
 
   export type Assets = {
     image?: string;
@@ -20,6 +21,10 @@ declare module '@docusaurus/plugin-content-pages' {
     include: string[];
     exclude: string[];
     mdxPageComponent: string;
+    showLastUpdateTime: boolean;
+    showLastUpdateAuthor: boolean;
+    editUrl?: string | EditUrlFunction;
+    editLocalizedFiles?: boolean;
   };
 
   export type Options = Partial<PluginOptions>;
@@ -35,6 +40,7 @@ declare module '@docusaurus/plugin-content-pages' {
     readonly toc_max_heading_level?: number;
     readonly draft?: boolean;
     readonly unlisted?: boolean;
+    readonly last_update?: FrontMatterLastUpdate;
   };
 
   export type JSXPageMetadata = {
@@ -43,16 +49,31 @@ declare module '@docusaurus/plugin-content-pages' {
     source: string;
   };
 
-  export type MDXPageMetadata = {
+  export type MDXPageMetadata = LastUpdateData & {
     type: 'mdx';
     permalink: string;
     source: string;
     frontMatter: PageFrontMatter & {[key: string]: unknown};
+    editUrl?: string;
     title?: string;
     description?: string;
     unlisted: boolean;
   };
 
+  export type EditUrlFunction = (editUrlParams: {
+    /**
+     * The root content directory containing this post file, relative to the
+     * site path. Usually the same as `options.path` but can be localized
+     */
+    pagesDirPath: string;
+    /** Path to this pages file, relative to `pagesDirPath`. */
+    pagesPath: string;
+    /** @see {@link PagesPostMetadata.permalink} */
+    permalink: string;
+    /** Locale name. */
+    locale: string;
+  }) => string | undefined;
+
   export type Metadata = JSXPageMetadata | MDXPageMetadata;
 
   export type LoadedContent = Metadata[];