feat(pages): add support for last update date & author

facebook · Apr 9, 2024 · 426b8fc · 426b8fc
1 parent 73016d4
commit 426b8fc
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 6 deletions.
diff --git a/packages/docusaurus-plugin-content-pages/src/index.ts b/packages/docusaurus-plugin-content-pages/src/index.ts
@@ -23,6 +23,7 @@ import {
   parseMarkdownFile,
   isUnlisted,
   isDraft,
+  readLastUpdateData,
 } from '@docusaurus/utils';
 import {validatePageFrontMatter} from './frontMatter';
 import type {LoadContext, Plugin, RouteMetadata} from '@docusaurus/types';
@@ -159,12 +160,27 @@ export default function pluginContentPages(
 
       const {addRoute, createData} = actions;
 
-      function createPageRouteMetadata(metadata: Metadata): RouteMetadata {
+      async function createPageRouteMetadata(
+        metadata: Metadata,
+      ): Promise<RouteMetadata> {
+        if (metadata.type === 'mdx') {
+          const lastUpdate = await readLastUpdateData(
+            metadata.source,
+            options,
+            metadata.frontMatter.last_update,
+          );
+
+          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: lastUpdate.lastUpdatedAt,
+          };
+        }
+
         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,
         };
       }
@@ -184,7 +200,7 @@ export default function pluginContentPages(
               path: permalink,
               component: options.mdxPageComponent,
               exact: true,
-              metadata: routeMetadata,
+              metadata: await routeMetadata,
               modules: {
                 content: source,
               },
@@ -194,7 +210,7 @@ export default function pluginContentPages(
               path: permalink,
               component: source,
               exact: true,
-              metadata: routeMetadata,
+              metadata: await routeMetadata,
               modules: {
                 config: `@generated/docusaurus.config`,
               },

diff --git a/packages/docusaurus-plugin-content-pages/src/options.ts b/packages/docusaurus-plugin-content-pages/src/options.ts
@@ -27,6 +27,8 @@ export const DEFAULT_OPTIONS: PluginOptions = {
   beforeDefaultRehypePlugins: [],
   beforeDefaultRemarkPlugins: [],
   admonitions: true,
+  showLastUpdateTime: false,
+  showLastUpdateAuthor: false,
 };
 
 const PluginOptionSchema = Joi.object<PluginOptions>({
@@ -44,6 +46,10 @@ 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,
+  ),
 });
 
 export function validateOptions({

diff --git a/packages/docusaurus-plugin-content-pages/src/plugin-content-pages.d.ts b/packages/docusaurus-plugin-content-pages/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} from '@docusaurus/utils';
 
   export type Assets = {
     image?: string;
@@ -20,6 +21,8 @@ declare module '@docusaurus/plugin-content-pages' {
     include: string[];
     exclude: string[];
     mdxPageComponent: string;
+    showLastUpdateTime: boolean;
+    showLastUpdateAuthor: boolean;
   };
 
   export type Options = Partial<PluginOptions>;
@@ -35,6 +38,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 = {

diff --git a/packages/docusaurus-theme-classic/src/theme/MDXPage/index.tsx b/packages/docusaurus-theme-classic/src/theme/MDXPage/index.tsx
@@ -30,6 +30,8 @@ export default function MDXPage(props: Props): JSX.Element {
     keywords,
     wrapperClassName,
     hide_table_of_contents: hideTableOfContents,
+    last_update: lastUpdate,
+    author,
   } = frontMatter;
   const image = assets.image ?? frontMatter.image;
 
@@ -67,6 +69,10 @@ export default function MDXPage(props: Props): JSX.Element {
             )}
           </div>
         </main>
+        <div>Author 1 : {author as string}</div>
+        <div>Author 2 : {lastUpdate?.author}</div>
+        <div>Date : {String(lastUpdate?.date)}</div>
+        <div>Json : {JSON.stringify(frontMatter)}</div>
       </Layout>
     </HtmlClassNameProvider>
   );