@docusaurus/plugin-content-docs 0.0.0-5868 → 0.0.0-5872

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/package.json

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

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

@@ -17,6 +17,7 @@ declare module '@docusaurus/plugin-content-docs' {
     TagModule,
     Tag,
     FrontMatterLastUpdate,
+    LastUpdateData,
   } from '@docusaurus/utils';
   import type {Plugin, LoadContext} from '@docusaurus/types';
   import type {Overwrite, Required} from 'utility-types';
@@ -397,13 +398,6 @@ declare module '@docusaurus/plugin-content-docs' {
     last_update?: FrontMatterLastUpdate;
   };
 
-  export type LastUpdateData = {
-    /** A timestamp in **seconds**, directly acquired from `git log`. */
-    lastUpdatedAt?: number;
-    /** The author's name directly acquired from `git log`. */
-    lastUpdatedBy?: string;
-  };
-
   export type DocMetadataBase = LastUpdateData & {
     /**
      * The document id.

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,
         }),
       };