@docusaurus/plugin-content-docs 3.1.1 → 3.2.0

package/lib/client/index.js

@@ -13,9 +13,16 @@ const StableEmptyObject = {};
 // In blog-only mode, docs hooks are still used by the theme. We need a fail-
 // safe fallback when the docs plugin is not in use
 export const useAllDocsData = () => useAllPluginInstancesData('docusaurus-plugin-content-docs') ?? StableEmptyObject;
-export const useDocsData = (pluginId) => usePluginData('docusaurus-plugin-content-docs', pluginId, {
-    failfast: true,
-});
+export const useDocsData = (pluginId) => {
+    try {
+        return usePluginData('docusaurus-plugin-content-docs', pluginId, {
+            failfast: true,
+        });
+    }
+    catch (error) {
+        throw new Error(`You are using a feature of the Docusaurus docs plugin, but this plugin does not seem to be enabled${pluginId === 'Default' ? '' : ` (pluginId=${pluginId}`}`, { cause: error });
+    }
+};
 // TODO this feature should be provided by docusaurus core
 export function useActivePlugin(options = {}) {
     const data = useAllDocsData();

package/lib/docs.js

@@ -11,44 +11,11 @@ const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
-const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const utils_1 = require("@docusaurus/utils");
-const lastUpdate_1 = require("./lastUpdate");
+const frontMatter_1 = require("./frontMatter");
 const slug_1 = tslib_1.__importDefault(require("./slug"));
 const numberPrefix_1 = require("./numberPrefix");
-const frontMatter_1 = require("./frontMatter");
 const utils_2 = require("./sidebars/utils");
-async function readLastUpdateData(filePath, options, lastUpdateFrontMatter) {
-    const { showLastUpdateAuthor, showLastUpdateTime } = options;
-    if (showLastUpdateAuthor || showLastUpdateTime) {
-        const frontMatterTimestamp = lastUpdateFrontMatter?.date
-            ? new Date(lastUpdateFrontMatter.date).getTime() / 1000
-            : undefined;
-        if (lastUpdateFrontMatter?.author && lastUpdateFrontMatter.date) {
-            return {
-                lastUpdatedAt: frontMatterTimestamp,
-                lastUpdatedBy: lastUpdateFrontMatter.author,
-            };
-        }
-        // Use fake data in dev for faster development.
-        const fileLastUpdateData = process.env.NODE_ENV === 'production'
-            ? await (0, lastUpdate_1.getFileLastUpdate)(filePath)
-            : {
-                author: 'Author',
-                timestamp: 1539502055,
-            };
-        const { author, timestamp } = fileLastUpdateData ?? {};
-        return {
-            lastUpdatedBy: showLastUpdateAuthor
-                ? lastUpdateFrontMatter?.author ?? author
-                : undefined,
-            lastUpdatedAt: showLastUpdateTime
-                ? frontMatterTimestamp ?? timestamp
-                : undefined,
-        };
-    }
-    return {};
-}
 async function readDocFile(versionMetadata, source) {
     const contentPath = await (0, utils_1.getFolderContainingFile)((0, utils_1.getContentPathList)(versionMetadata), source);
     const filePath = path_1.default.join(contentPath, source);
@@ -66,7 +33,7 @@ async function readVersionDocs(versionMetadata, options) {
 exports.readVersionDocs = readVersionDocs;
 async function doProcessDocMetadata({ docFile, versionMetadata, context, options, env, }) {
     const { source, content, contentPath, filePath } = docFile;
-    const { siteDir, i18n, siteConfig: { markdown: { parseFrontMatter }, }, } = context;
+    const { siteDir, siteConfig: { markdown: { parseFrontMatter }, }, } = context;
     const { frontMatter: unsafeFrontMatter, contentTitle, excerpt, } = await (0, utils_1.parseMarkdownFile)({
         filePath,
         fileContent: content,
@@ -78,7 +45,7 @@ async function doProcessDocMetadata({ docFile, versionMetadata, context, options
     // (01-MyFolder/01-MyDoc.md => MyFolder/MyDoc)
     // but allow to disable this behavior with front matter
     parse_number_prefixes: parseNumberPrefixes = true, last_update: lastUpdateFrontMatter, } = frontMatter;
-    const lastUpdate = await readLastUpdateData(filePath, options, lastUpdateFrontMatter);
+    const lastUpdate = await (0, utils_1.readLastUpdateData)(filePath, options, lastUpdateFrontMatter);
     // E.g. api/plugins/myDoc -> myDoc; myDoc -> myDoc
     const sourceFileNameWithoutExtension = path_1.default.basename(source, path_1.default.extname(source));
     // E.g. api/plugins/myDoc -> api/plugins; myDoc -> .
@@ -141,21 +108,6 @@ async function doProcessDocMetadata({ docFile, versionMetadata, context, options
     }
     const draft = (0, utils_1.isDraft)({ env, frontMatter });
     const unlisted = (0, utils_1.isUnlisted)({ env, frontMatter });
-    const formatDate = (locale, date, calendar) => {
-        try {
-            return new Intl.DateTimeFormat(locale, {
-                day: 'numeric',
-                month: 'short',
-                year: 'numeric',
-                timeZone: 'UTC',
-                calendar,
-            }).format(date);
-        }
-        catch (err) {
-            logger_1.default.error `Can't format docs lastUpdatedAt date "${String(date)}"`;
-            throw err;
-        }
-    };
     // Assign all of object properties during instantiation (if possible) for
     // NodeJS optimization.
     // Adding properties to object after instantiation will cause hidden
@@ -175,9 +127,6 @@ async function doProcessDocMetadata({ docFile, versionMetadata, context, options
         version: versionMetadata.versionName,
         lastUpdatedBy: lastUpdate.lastUpdatedBy,
         lastUpdatedAt: lastUpdate.lastUpdatedAt,
-        formattedLastUpdatedAt: lastUpdate.lastUpdatedAt
-            ? formatDate(i18n.currentLocale, new Date(lastUpdate.lastUpdatedAt * 1000), i18n.localeConfigs[i18n.currentLocale].calendar)
-            : undefined,
         sidebarPosition,
         frontMatter,
     };

package/lib/frontMatter.d.ts

@@ -1,10 +1,5 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
 import type { DocFrontMatter } from '@docusaurus/plugin-content-docs';
+export declare const DocFrontMatterSchema: import("joi").ObjectSchema<DocFrontMatter>;
 export declare function validateDocFrontMatter(frontMatter: {
     [key: string]: unknown;
 }): DocFrontMatter;

package/lib/frontMatter.js

@@ -1,19 +1,18 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateDocFrontMatter = exports.DocFrontMatterSchema = void 0;
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateDocFrontMatter = void 0;
 const utils_validation_1 = require("@docusaurus/utils-validation");
-const FrontMatterLastUpdateErrorMessage = '{{#label}} does not look like a valid front matter FileChange object. Please use a FileChange object (with an author and/or date).';
 // NOTE: we don't add any default value on purpose here
 // We don't want default values to magically appear in doc metadata and props
 // While the user did not provide those values explicitly
 // We use default values in code instead
-const DocFrontMatterSchema = utils_validation_1.JoiFrontMatter.object({
+exports.DocFrontMatterSchema = utils_validation_1.JoiFrontMatter.object({
     id: utils_validation_1.JoiFrontMatter.string(),
     // See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
     title: utils_validation_1.JoiFrontMatter.string().allow(''),
@@ -36,19 +35,11 @@ const DocFrontMatterSchema = utils_validation_1.JoiFrontMatter.object({
     pagination_next: utils_validation_1.JoiFrontMatter.string().allow(null),
     pagination_prev: utils_validation_1.JoiFrontMatter.string().allow(null),
     ...utils_validation_1.FrontMatterTOCHeadingLevels,
-    last_update: utils_validation_1.JoiFrontMatter.object({
-        author: utils_validation_1.JoiFrontMatter.string(),
-        date: utils_validation_1.JoiFrontMatter.date().raw(),
-    })
-        .or('author', 'date')
-        .messages({
-        'object.missing': FrontMatterLastUpdateErrorMessage,
-        'object.base': FrontMatterLastUpdateErrorMessage,
-    }),
+    last_update: utils_validation_1.FrontMatterLastUpdateSchema,
 })
     .unknown()
     .concat(utils_validation_1.ContentVisibilitySchema);
 function validateDocFrontMatter(frontMatter) {
-    return (0, utils_validation_1.validateFrontMatter)(frontMatter, DocFrontMatterSchema);
+    return (0, utils_validation_1.validateFrontMatter)(frontMatter, exports.DocFrontMatterSchema);
 }
 exports.validateDocFrontMatter = validateDocFrontMatter;

package/lib/routes.js

@@ -13,6 +13,12 @@ const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const utils_1 = require("@docusaurus/utils");
 const props_1 = require("./props");
 const tags_1 = require("./tags");
+function createDocRouteMetadata(docMeta) {
+    return {
+        sourceFilePath: (0, utils_1.aliasedSitePathToRelativePath)(docMeta.source),
+        lastUpdatedAt: docMeta.lastUpdatedAt,
+    };
+}
 async function buildVersionCategoryGeneratedIndexRoutes({ version, actions, options, aliasedSource, }) {
     const slugs = (0, utils_1.createSlugger)();
     async function buildCategoryGeneratedIndexRoute(categoryGeneratedIndex) {
@@ -34,23 +40,24 @@ async function buildVersionCategoryGeneratedIndexRoutes({ version, actions, opti
     return Promise.all(version.categoryGeneratedIndices.map(buildCategoryGeneratedIndexRoute));
 }
 async function buildVersionDocRoutes({ version, actions, options, }) {
-    return Promise.all(version.docs.map(async (metadataItem) => {
+    return Promise.all(version.docs.map(async (doc) => {
         await actions.createData(
         // Note that this created data path must be in sync with
         // metadataPath provided to mdx-loader.
-        `${(0, utils_1.docuHash)(metadataItem.source)}.json`, JSON.stringify(metadataItem, null, 2));
+        `${(0, utils_1.docuHash)(doc.source)}.json`, JSON.stringify(doc, null, 2));
         const docRoute = {
-            path: metadataItem.permalink,
+            path: doc.permalink,
             component: options.docItemComponent,
             exact: true,
             modules: {
-                content: metadataItem.source,
+                content: doc.source,
             },
+            metadata: createDocRouteMetadata(doc),
             // Because the parent (DocRoot) comp need to access it easily
             // This permits to render the sidebar once without unmount/remount when
             // navigating (and preserve sidebar state)
-            ...(metadataItem.sidebar && {
-                sidebar: metadataItem.sidebar,
+            ...(doc.sidebar && {
+                sidebar: doc.sidebar,
             }),
         };
         return docRoute;

package/lib/sidebars/generator.js

@@ -11,7 +11,7 @@ const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
-const utils_1 = require("@docusaurus/utils");
+const utils_common_1 = require("@docusaurus/utils-common");
 const docs_1 = require("../docs");
 const BreadcrumbSeparator = '/';
 // Just an alias to the make code more explicit
@@ -45,7 +45,7 @@ Available doc IDs:
                 autogenDir === '.' ||
                 // Autogen dir is not . and doc is in subfolder
                 // "api/myDoc" startsWith "api/" (note "api2/myDoc" is not included)
-                doc.sourceDirName.startsWith((0, utils_1.addTrailingSlash)(autogenDir)));
+                doc.sourceDirName.startsWith((0, utils_common_1.addTrailingSlash)(autogenDir)));
         }
         const docs = allDocs.filter(isInAutogeneratedDir);
         if (docs.length === 0) {
@@ -66,7 +66,7 @@ Available doc IDs:
             return autogenDir === doc.sourceDirName
                 ? []
                 : doc.sourceDirName
-                    .replace((0, utils_1.addTrailingSlash)(autogenDir), '')
+                    .replace((0, utils_common_1.addTrailingSlash)(autogenDir), '')
                     .split(BreadcrumbSeparator);
         }
         const treeRoot = {};

package/lib/slug.js

@@ -7,6 +7,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("@docusaurus/utils");
+const utils_common_1 = require("@docusaurus/utils-common");
 const numberPrefix_1 = require("./numberPrefix");
 const docs_1 = require("./docs");
 function getSlug({ baseID, frontMatterSlug, source, sourceDirName, stripDirNumberPrefixes = true, numberPrefixParser = numberPrefix_1.DefaultNumberPrefixParser, }) {
@@ -16,7 +17,7 @@ function getSlug({ baseID, frontMatterSlug, source, sourceDirName, stripDirNumbe
             : sourceDirName;
         const resolveDirname = sourceDirName === '.'
             ? '/'
-            : (0, utils_1.addLeadingSlash)((0, utils_1.addTrailingSlash)(dirNameStripped));
+            : (0, utils_common_1.addLeadingSlash)((0, utils_common_1.addTrailingSlash)(dirNameStripped));
         return resolveDirname;
     }
     function computeSlug() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "3.1.1",
+  "version": "3.2.0",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": false,
@@ -35,13 +35,14 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "3.1.1",
-    "@docusaurus/logger": "3.1.1",
-    "@docusaurus/mdx-loader": "3.1.1",
-    "@docusaurus/module-type-aliases": "3.1.1",
-    "@docusaurus/types": "3.1.1",
-    "@docusaurus/utils": "3.1.1",
-    "@docusaurus/utils-validation": "3.1.1",
+    "@docusaurus/core": "3.2.0",
+    "@docusaurus/logger": "3.2.0",
+    "@docusaurus/mdx-loader": "3.2.0",
+    "@docusaurus/module-type-aliases": "3.2.0",
+    "@docusaurus/types": "3.2.0",
+    "@docusaurus/utils": "3.2.0",
+    "@docusaurus/utils-common": "3.2.0",
+    "@docusaurus/utils-validation": "3.2.0",
     "@types/react-router-config": "^5.0.7",
     "combine-promises": "^1.1.0",
     "fs-extra": "^11.1.1",
@@ -65,5 +66,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "8017f6a6776ba1bd7065e630a52fe2c2654e2f1b"
+  "gitHead": "5af143651b26b39761361acd96e9c5be7ba0cb25"
 }

package/src/client/index.ts

@@ -86,10 +86,20 @@ export const useAllDocsData = (): {[pluginId: string]: GlobalPluginData} =>
       }
     | undefined) ?? StableEmptyObject;
 
-export const useDocsData = (pluginId: string | undefined): GlobalPluginData =>
-  usePluginData('docusaurus-plugin-content-docs', pluginId, {
-    failfast: true,
-  }) as GlobalPluginData;
+export const useDocsData = (pluginId: string | undefined): GlobalPluginData => {
+  try {
+    return usePluginData('docusaurus-plugin-content-docs', pluginId, {
+      failfast: true,
+    }) as GlobalPluginData;
+  } catch (error) {
+    throw new Error(
+      `You are using a feature of the Docusaurus docs plugin, but this plugin does not seem to be enabled${
+        pluginId === 'Default' ? '' : ` (pluginId=${pluginId}`
+      }`,
+      {cause: error as Error},
+    );
+  }
+};
 
 // TODO this feature should be provided by docusaurus core
 export function useActivePlugin(

package/src/docs.ts

@@ -8,7 +8,6 @@
 import path from 'path';
 import fs from 'fs-extra';
 import _ from 'lodash';
-import logger from '@docusaurus/logger';
 import {
   aliasedSitePath,
   getEditUrl,
@@ -21,12 +20,11 @@ import {
   normalizeFrontMatterTags,
   isUnlisted,
   isDraft,
+  readLastUpdateData,
 } from '@docusaurus/utils';
-
-import {getFileLastUpdate} from './lastUpdate';
+import {validateDocFrontMatter} from './frontMatter';
 import getSlug from './slug';
 import {stripPathNumberPrefixes} from './numberPrefix';
-import {validateDocFrontMatter} from './frontMatter';
 import {toDocNavigationLink, toNavigationLink} from './sidebars/utils';
 import type {
   MetadataOptions,
@@ -35,61 +33,13 @@ import type {
   DocMetadataBase,
   DocMetadata,
   PropNavigationLink,
-  LastUpdateData,
   VersionMetadata,
   LoadedVersion,
-  FileChange,
 } from '@docusaurus/plugin-content-docs';
 import type {LoadContext} from '@docusaurus/types';
 import type {SidebarsUtils} from './sidebars/utils';
 import type {DocFile} from './types';
 
-type LastUpdateOptions = Pick<
-  PluginOptions,
-  'showLastUpdateAuthor' | 'showLastUpdateTime'
->;
-
-async function readLastUpdateData(
-  filePath: string,
-  options: LastUpdateOptions,
-  lastUpdateFrontMatter: FileChange | undefined,
-): Promise<LastUpdateData> {
-  const {showLastUpdateAuthor, showLastUpdateTime} = options;
-  if (showLastUpdateAuthor || showLastUpdateTime) {
-    const frontMatterTimestamp = lastUpdateFrontMatter?.date
-      ? new Date(lastUpdateFrontMatter.date).getTime() / 1000
-      : undefined;
-
-    if (lastUpdateFrontMatter?.author && lastUpdateFrontMatter.date) {
-      return {
-        lastUpdatedAt: frontMatterTimestamp,
-        lastUpdatedBy: lastUpdateFrontMatter.author,
-      };
-    }
-
-    // Use fake data in dev for faster development.
-    const fileLastUpdateData =
-      process.env.NODE_ENV === 'production'
-        ? await getFileLastUpdate(filePath)
-        : {
-            author: 'Author',
-            timestamp: 1539502055,
-          };
-    const {author, timestamp} = fileLastUpdateData ?? {};
-
-    return {
-      lastUpdatedBy: showLastUpdateAuthor
-        ? lastUpdateFrontMatter?.author ?? author
-        : undefined,
-      lastUpdatedAt: showLastUpdateTime
-        ? frontMatterTimestamp ?? timestamp
-        : undefined,
-    };
-  }
-
-  return {};
-}
-
 export async function readDocFile(
   versionMetadata: Pick<
     VersionMetadata,
@@ -142,7 +92,6 @@ async function doProcessDocMetadata({
   const {source, content, contentPath, filePath} = docFile;
   const {
     siteDir,
-    i18n,
     siteConfig: {
       markdown: {parseFrontMatter},
     },
@@ -257,21 +206,6 @@ async function doProcessDocMetadata({
   const draft = isDraft({env, frontMatter});
   const unlisted = isUnlisted({env, frontMatter});
 
-  const formatDate = (locale: string, date: Date, calendar: string): string => {
-    try {
-      return new Intl.DateTimeFormat(locale, {
-        day: 'numeric',
-        month: 'short',
-        year: 'numeric',
-        timeZone: 'UTC',
-        calendar,
-      }).format(date);
-    } catch (err) {
-      logger.error`Can't format docs lastUpdatedAt date "${String(date)}"`;
-      throw err;
-    }
-  };
-
   // Assign all of object properties during instantiation (if possible) for
   // NodeJS optimization.
   // Adding properties to object after instantiation will cause hidden
@@ -291,13 +225,6 @@ async function doProcessDocMetadata({
     version: versionMetadata.versionName,
     lastUpdatedBy: lastUpdate.lastUpdatedBy,
     lastUpdatedAt: lastUpdate.lastUpdatedAt,
-    formattedLastUpdatedAt: lastUpdate.lastUpdatedAt
-      ? formatDate(
-          i18n.currentLocale,
-          new Date(lastUpdate.lastUpdatedAt * 1000),
-          i18n.localeConfigs[i18n.currentLocale]!.calendar,
-        )
-      : undefined,
     sidebarPosition,
     frontMatter,
   };

package/src/frontMatter.ts

@@ -4,7 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-
 import {
   JoiFrontMatter as Joi, // Custom instance for front matter
   URISchema,
@@ -12,17 +11,15 @@ import {
   FrontMatterTOCHeadingLevels,
   validateFrontMatter,
   ContentVisibilitySchema,
+  FrontMatterLastUpdateSchema,
 } from '@docusaurus/utils-validation';
 import type {DocFrontMatter} from '@docusaurus/plugin-content-docs';
 
-const FrontMatterLastUpdateErrorMessage =
-  '{{#label}} does not look like a valid front matter FileChange object. Please use a FileChange object (with an author and/or date).';
-
 // NOTE: we don't add any default value on purpose here
 // We don't want default values to magically appear in doc metadata and props
 // While the user did not provide those values explicitly
 // We use default values in code instead
-const DocFrontMatterSchema = Joi.object<DocFrontMatter>({
+export const DocFrontMatterSchema = Joi.object<DocFrontMatter>({
   id: Joi.string(),
   // See https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
   title: Joi.string().allow(''),
@@ -45,15 +42,7 @@ const DocFrontMatterSchema = Joi.object<DocFrontMatter>({
   pagination_next: Joi.string().allow(null),
   pagination_prev: Joi.string().allow(null),
   ...FrontMatterTOCHeadingLevels,
-  last_update: Joi.object({
-    author: Joi.string(),
-    date: Joi.date().raw(),
-  })
-    .or('author', 'date')
-    .messages({
-      'object.missing': FrontMatterLastUpdateErrorMessage,
-      'object.base': FrontMatterLastUpdateErrorMessage,
-    }),
+  last_update: FrontMatterLastUpdateSchema,
 })
   .unknown()
   .concat(ContentVisibilitySchema);

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

@@ -16,6 +16,8 @@ declare module '@docusaurus/plugin-content-docs' {
     TagsListItem,
     TagModule,
     Tag,
+    FrontMatterLastUpdate,
+    LastUpdateData,
   } from '@docusaurus/utils';
   import type {Plugin, LoadContext} from '@docusaurus/types';
   import type {Overwrite, Required} from 'utility-types';
@@ -24,14 +26,6 @@ declare module '@docusaurus/plugin-content-docs' {
     image?: string;
   };
 
-  export type FileChange = {
-    author?: string;
-    /** Date can be any
-     * [parsable date string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse).
-     */
-    date?: Date | string;
-  };
-
   /**
    * Custom callback for parsing number prefixes from file/folder names.
    */
@@ -93,9 +87,9 @@ declare module '@docusaurus/plugin-content-docs' {
      */
     editLocalizedFiles: boolean;
     /**	Whether to display the last date the doc was updated. */
-    showLastUpdateTime?: boolean;
+    showLastUpdateTime: boolean;
     /** Whether to display the author who last updated the doc. */
-    showLastUpdateAuthor?: boolean;
+    showLastUpdateAuthor: boolean;
     /**
      * Custom parsing logic to extract number prefixes from file names. Use
      * `false` to disable this behavior and leave the docs untouched, and `true`
@@ -401,16 +395,7 @@ declare module '@docusaurus/plugin-content-docs' {
     /** Should this doc be accessible but hidden in production builds? */
     unlisted?: boolean;
     /** Allows overriding the last updated author and/or date. */
-    last_update?: FileChange;
-  };
-
-  export type LastUpdateData = {
-    /** A timestamp in **seconds**, directly acquired from `git log`. */
-    lastUpdatedAt?: number;
-    /** `lastUpdatedAt` formatted as a date according to the current locale. */
-    formattedLastUpdatedAt?: string;
-    /** The author's name directly acquired from `git log`. */
-    lastUpdatedBy?: string;
+    last_update?: FrontMatterLastUpdate;
   };
 
   export type DocMetadataBase = LastUpdateData & {

package/src/routes.ts

@@ -7,21 +7,38 @@
 
 import _ from 'lodash';
 import logger from '@docusaurus/logger';
-import {docuHash, createSlugger, normalizeUrl} from '@docusaurus/utils';
+import {
+  docuHash,
+  createSlugger,
+  normalizeUrl,
+  aliasedSitePathToRelativePath,
+} from '@docusaurus/utils';
 import {
   toTagDocListProp,
   toTagsListTagsProp,
   toVersionMetadataProp,
 } from './props';
 import {getVersionTags} from './tags';
-import type {PluginContentLoadedActions, RouteConfig} from '@docusaurus/types';
+import type {
+  PluginContentLoadedActions,
+  RouteConfig,
+  RouteMetadata,
+} from '@docusaurus/types';
 import type {FullVersion, VersionTag} from './types';
 import type {
   CategoryGeneratedIndexMetadata,
+  DocMetadata,
   PluginOptions,
   PropTagsListPage,
 } from '@docusaurus/plugin-content-docs';
 
+function createDocRouteMetadata(docMeta: DocMetadata): RouteMetadata {
+  return {
+    sourceFilePath: aliasedSitePathToRelativePath(docMeta.source),
+    lastUpdatedAt: docMeta.lastUpdatedAt,
+  };
+}
+
 async function buildVersionCategoryGeneratedIndexRoutes({
   version,
   actions,
@@ -68,26 +85,27 @@ async function buildVersionDocRoutes({
   options,
 }: BuildVersionRoutesParam): Promise<RouteConfig[]> {
   return Promise.all(
-    version.docs.map(async (metadataItem) => {
+    version.docs.map(async (doc) => {
       await actions.createData(
         // Note that this created data path must be in sync with
         // metadataPath provided to mdx-loader.
-        `${docuHash(metadataItem.source)}.json`,
-        JSON.stringify(metadataItem, null, 2),
+        `${docuHash(doc.source)}.json`,
+        JSON.stringify(doc, null, 2),
       );
 
       const docRoute: RouteConfig = {
-        path: metadataItem.permalink,
+        path: doc.permalink,
         component: options.docItemComponent,
         exact: true,
         modules: {
-          content: metadataItem.source,
+          content: doc.source,
         },
+        metadata: createDocRouteMetadata(doc),
         // Because the parent (DocRoot) comp need to access it easily
         // This permits to render the sidebar once without unmount/remount when
         // navigating (and preserve sidebar state)
-        ...(metadataItem.sidebar && {
-          sidebar: metadataItem.sidebar,
+        ...(doc.sidebar && {
+          sidebar: doc.sidebar,
         }),
       };
 

package/src/sidebars/generator.ts

@@ -8,7 +8,7 @@
 import path from 'path';
 import _ from 'lodash';
 import logger from '@docusaurus/logger';
-import {addTrailingSlash} from '@docusaurus/utils';
+import {addTrailingSlash} from '@docusaurus/utils-common';
 import {createDocsByIdIndex, toCategoryIndexMatcherParam} from '../docs';
 import type {
   SidebarItemDoc,

package/src/slug.ts

@@ -5,12 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {
-  addLeadingSlash,
-  addTrailingSlash,
-  isValidPathname,
-  resolvePathname,
-} from '@docusaurus/utils';
+import {isValidPathname, resolvePathname} from '@docusaurus/utils';
+import {addLeadingSlash, addTrailingSlash} from '@docusaurus/utils-common';
 import {
   DefaultNumberPrefixParser,
   stripPathNumberPrefixes,

package/lib/lastUpdate.d.ts

@@ -1,10 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-export declare function getFileLastUpdate(filePath: string): Promise<{
-    timestamp: number;
-    author: string;
-} | null>;

package/lib/lastUpdate.js

@@ -1,47 +0,0 @@
-"use strict";
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFileLastUpdate = void 0;
-const tslib_1 = require("tslib");
-const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
-const utils_1 = require("@docusaurus/utils");
-let showedGitRequirementError = false;
-let showedFileNotTrackedError = false;
-async function getFileLastUpdate(filePath) {
-    if (!filePath) {
-        return null;
-    }
-    // Wrap in try/catch in case the shell commands fail
-    // (e.g. project doesn't use Git, etc).
-    try {
-        const result = (0, utils_1.getFileCommitDate)(filePath, {
-            age: 'newest',
-            includeAuthor: true,
-        });
-        return { timestamp: result.timestamp, author: result.author };
-    }
-    catch (err) {
-        if (err instanceof utils_1.GitNotFoundError) {
-            if (!showedGitRequirementError) {
-                logger_1.default.warn('Sorry, the docs plugin last update options require Git.');
-                showedGitRequirementError = true;
-            }
-        }
-        else if (err instanceof utils_1.FileNotTrackedError) {
-            if (!showedFileNotTrackedError) {
-                logger_1.default.warn('Cannot infer the update date for some files, as they are not tracked by git.');
-                showedFileNotTrackedError = true;
-            }
-        }
-        else {
-            logger_1.default.warn(err);
-        }
-        return null;
-    }
-}
-exports.getFileLastUpdate = getFileLastUpdate;

package/src/lastUpdate.ts

@@ -1,51 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-import logger from '@docusaurus/logger';
-import {
-  getFileCommitDate,
-  FileNotTrackedError,
-  GitNotFoundError,
-} from '@docusaurus/utils';
-
-let showedGitRequirementError = false;
-let showedFileNotTrackedError = false;
-
-export async function getFileLastUpdate(
-  filePath: string,
-): Promise<{timestamp: number; author: string} | null> {
-  if (!filePath) {
-    return null;
-  }
-
-  // Wrap in try/catch in case the shell commands fail
-  // (e.g. project doesn't use Git, etc).
-  try {
-    const result = getFileCommitDate(filePath, {
-      age: 'newest',
-      includeAuthor: true,
-    });
-    return {timestamp: result.timestamp, author: result.author};
-  } catch (err) {
-    if (err instanceof GitNotFoundError) {
-      if (!showedGitRequirementError) {
-        logger.warn('Sorry, the docs plugin last update options require Git.');
-        showedGitRequirementError = true;
-      }
-    } else if (err instanceof FileNotTrackedError) {
-      if (!showedFileNotTrackedError) {
-        logger.warn(
-          'Cannot infer the update date for some files, as they are not tracked by git.',
-        );
-        showedFileNotTrackedError = true;
-      }
-    } else {
-      logger.warn(err);
-    }
-    return null;
-  }
-}