@docusaurus/plugin-content-docs 0.0.0-4240 → 0.0.0-4244

package/lib/docs.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.handleNavigation = exports.processDocMetadata = exports.readVersionDocs = exports.readDocFile = void 0;
+exports.createDocsByIdIndex = exports.getDocIds = exports.isConventionalDocIndex = exports.getMainDocId = exports.addDocNavigation = exports.processDocMetadata = exports.readVersionDocs = exports.readDocFile = void 0;
 const tslib_1 = require("tslib");
 const path_1 = (0, tslib_1.__importDefault)(require("path"));
 const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
@@ -116,7 +116,8 @@ function doProcessDocMetadata({ docFile, versionMetadata, context, options, }) {
         ? '/'
         : (0, slug_1.default)({
             baseID,
-            dirName: sourceDirName,
+            source,
+            sourceDirName,
             frontmatterSlug: frontMatter.slug,
             stripDirNumberPrefixes: parseNumberPrefixes,
             numberPrefixParser: options.numberPrefixParser,
@@ -184,44 +185,48 @@ function processDocMetadata(args) {
     }
 }
 exports.processDocMetadata = processDocMetadata;
-function handleNavigation(docsBase, sidebars, sidebarFilePath) {
-    const docsBaseById = (0, lodash_1.keyBy)(docsBase, (doc) => doc.id);
-    const { checkSidebarsDocIds, getDocNavigation, getFirstDocIdOfFirstSidebar } = (0, utils_2.createSidebarsUtils)(sidebars);
-    const validDocIds = Object.keys(docsBaseById);
-    checkSidebarsDocIds(validDocIds, sidebarFilePath);
+function addDocNavigation(docsBase, sidebarsUtils, sidebarFilePath) {
+    const docsById = createDocsByIdIndex(docsBase);
+    sidebarsUtils.checkSidebarsDocIds(docsBase.flatMap(getDocIds), sidebarFilePath);
     // Add sidebar/next/previous to the docs
     function addNavData(doc) {
-        const { sidebarName, previousId, nextId } = getDocNavigation(doc.id);
-        const toDocNavLink = (docId, type) => {
-            var _a;
+        const navigation = sidebarsUtils.getDocNavigation(doc.unversionedId, doc.id);
+        const toNavigationLinkByDocId = (docId, type) => {
             if (!docId) {
                 return undefined;
             }
-            if (!docsBaseById[docId]) {
+            const navDoc = docsById[docId];
+            if (!navDoc) {
                 // This could only happen if user provided the ID through front matter
                 throw new Error(`Error when loading ${doc.id} in ${doc.sourceDirName}: the pagination_${type} front matter points to a non-existent ID ${docId}.`);
             }
-            const { title, permalink, frontMatter: { pagination_label: paginationLabel, sidebar_label: sidebarLabel, }, } = docsBaseById[docId];
-            return { title: (_a = paginationLabel !== null && paginationLabel !== void 0 ? paginationLabel : sidebarLabel) !== null && _a !== void 0 ? _a : title, permalink };
+            return (0, utils_2.toDocNavigationLink)(navDoc);
         };
-        const { frontMatter: { pagination_next: paginationNext = nextId, pagination_prev: paginationPrev = previousId, }, } = doc;
-        const previous = toDocNavLink(paginationPrev, 'prev');
-        const next = toDocNavLink(paginationNext, 'next');
-        return { ...doc, sidebar: sidebarName, previous, next };
+        const previous = doc.frontMatter.pagination_prev
+            ? toNavigationLinkByDocId(doc.frontMatter.pagination_prev, 'prev')
+            : (0, utils_2.toNavigationLink)(navigation.previous, docsById);
+        const next = doc.frontMatter.pagination_next
+            ? toNavigationLinkByDocId(doc.frontMatter.pagination_next, 'next')
+            : (0, utils_2.toNavigationLink)(navigation.next, docsById);
+        return { ...doc, sidebar: navigation.sidebarName, previous, next };
     }
-    const docs = docsBase.map(addNavData);
+    const docsWithNavigation = docsBase.map(addNavData);
     // sort to ensure consistent output for tests
-    docs.sort((a, b) => a.id.localeCompare(b.id));
-    /**
-     * The "main doc" is the "version entry point"
-     * We browse this doc by clicking on a version:
-     * - the "home" doc (at '/docs/')
-     * - the first doc of the first sidebar
-     * - a random doc (if no docs are in any sidebar... edge case)
-     */
+    docsWithNavigation.sort((a, b) => a.id.localeCompare(b.id));
+    return docsWithNavigation;
+}
+exports.addDocNavigation = addDocNavigation;
+/**
+ * The "main doc" is the "version entry point"
+ * We browse this doc by clicking on a version:
+ * - the "home" doc (at '/docs/')
+ * - the first doc of the first sidebar
+ * - a random doc (if no docs are in any sidebar... edge case)
+ */
+function getMainDocId({ docs, sidebarsUtils, }) {
     function getMainDoc() {
         const versionHomeDoc = docs.find((doc) => doc.slug === '/');
-        const firstDocIdOfFirstSidebar = getFirstDocIdOfFirstSidebar();
+        const firstDocIdOfFirstSidebar = sidebarsUtils.getFirstDocIdOfFirstSidebar();
         if (versionHomeDoc) {
             return versionHomeDoc;
         }
@@ -232,6 +237,43 @@ function handleNavigation(docsBase, sidebars, sidebarFilePath) {
             return docs[0];
         }
     }
-    return { mainDocId: getMainDoc().unversionedId, docs };
+    return getMainDoc().unversionedId;
+}
+exports.getMainDocId = getMainDocId;
+function getLastPathSegment(str) {
+    return (0, lodash_1.last)(str.split('/'));
+}
+// By convention, Docusaurus considers some docs are "indexes":
+// - index.md
+// - readme.md
+// - <folder>/<folder>.md
+//
+// Those index docs produce a different behavior
+// - Slugs do not end with a weird "/index" suffix
+// - Auto-generated sidebar categories link to them as intro
+function isConventionalDocIndex(doc) {
+    // "@site/docs/folder/subFolder/subSubFolder/myDoc.md" => "myDoc"
+    const docName = path_1.default.parse(doc.source).name;
+    // "folder/subFolder/subSubFolder" => "subSubFolder"
+    const lastDirName = getLastPathSegment(doc.sourceDirName);
+    const eligibleDocIndexNames = ['index', 'readme', lastDirName.toLowerCase()];
+    return eligibleDocIndexNames.includes(docName.toLowerCase());
+}
+exports.isConventionalDocIndex = isConventionalDocIndex;
+// Return both doc ids
+// TODO legacy retro-compatibility due to old versioned sidebars using versioned doc ids
+// ("id" should be removed & "versionedId" should be renamed to "id")
+function getDocIds(doc) {
+    return [doc.unversionedId, doc.id];
+}
+exports.getDocIds = getDocIds;
+// docs are indexed by both versioned and unversioned ids at the same time
+// TODO legacy retro-compatibility due to old versioned sidebars using versioned doc ids
+// ("id" should be removed & "versionedId" should be renamed to "id")
+function createDocsByIdIndex(docs) {
+    return {
+        ...(0, lodash_1.keyBy)(docs, (doc) => doc.unversionedId),
+        ...(0, lodash_1.keyBy)(docs, (doc) => doc.id),
+    };
 }
-exports.handleNavigation = handleNavigation;
+exports.createDocsByIdIndex = createDocsByIdIndex;

package/lib/index.js

@@ -23,6 +23,9 @@ const props_1 = require("./props");
 const translations_1 = require("./translations");
 const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
 const tags_1 = require("./tags");
+const routes_1 = require("./routes");
+const utils_2 = require("./sidebars/utils");
+const categoryGeneratedIndex_1 = require("./categoryGeneratedIndex");
 function pluginContentDocs(context, options) {
     var _a;
     const { siteDir, generatedFilesDir, baseUrl, siteConfig } = context;
@@ -95,21 +98,28 @@ function pluginContentDocs(context, options) {
                 return Promise.all(docFiles.map(processVersionDoc));
             }
             async function doLoadVersion(versionMetadata) {
-                const docsBase = await loadVersionDocsBase(versionMetadata);
+                const docs = await loadVersionDocsBase(versionMetadata);
                 const sidebars = await (0, sidebars_1.loadSidebars)(versionMetadata.sidebarFilePath, {
                     sidebarItemsGenerator: options.sidebarItemsGenerator,
                     numberPrefixParser: options.numberPrefixParser,
-                    docs: docsBase,
+                    docs,
                     version: versionMetadata,
-                    options: {
+                    sidebarOptions: {
                         sidebarCollapsed: options.sidebarCollapsed,
                         sidebarCollapsible: options.sidebarCollapsible,
                     },
+                    categoryLabelSlugger: (0, utils_1.createSlugger)(),
                 });
+                const sidebarsUtils = (0, utils_2.createSidebarsUtils)(sidebars);
                 return {
                     ...versionMetadata,
-                    ...(0, docs_1.handleNavigation)(docsBase, sidebars, versionMetadata.sidebarFilePath),
+                    docs: (0, docs_1.addDocNavigation)(docs, sidebarsUtils, versionMetadata.sidebarFilePath),
                     sidebars,
+                    mainDocId: (0, docs_1.getMainDocId)({ docs, sidebarsUtils }),
+                    categoryGeneratedIndices: (0, categoryGeneratedIndex_1.getCategoryGeneratedIndexMetadataList)({
+                        docs,
+                        sidebarsUtils,
+                    }),
                 };
             }
             async function loadVersion(versionMetadata) {
@@ -130,33 +140,11 @@ function pluginContentDocs(context, options) {
         },
         async contentLoaded({ content, actions }) {
             const { loadedVersions } = content;
-            const { docLayoutComponent, docItemComponent } = options;
+            const { docLayoutComponent, docItemComponent, docCategoryGeneratedIndexComponent, } = options;
             const { addRoute, createData, setGlobalData } = actions;
-            const createDocRoutes = async (docs) => {
-                const routes = await Promise.all(docs.map(async (metadataItem) => {
-                    await 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));
-                    const docRoute = {
-                        path: metadataItem.permalink,
-                        component: docItemComponent,
-                        exact: true,
-                        modules: {
-                            content: metadataItem.source,
-                        },
-                        // Because the parent (DocPage) 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,
-                        }),
-                    };
-                    return docRoute;
-                }));
-                return routes.sort((a, b) => a.path.localeCompare(b.path));
-            };
-            async function createVersionTagsRoutes(loadedVersion) {
-                const versionTags = (0, tags_1.getVersionTags)(loadedVersion.docs);
+            async function createVersionTagsRoutes(version) {
+                const versionTags = (0, tags_1.getVersionTags)(version.docs);
+                // TODO tags should be a sub route of the version route
                 async function createTagsListPage() {
                     const tagsProp = Object.values(versionTags).map((tagValue) => ({
                         name: tagValue.name,
@@ -165,9 +153,9 @@ function pluginContentDocs(context, options) {
                     }));
                     // Only create /tags page if there are tags.
                     if (Object.keys(tagsProp).length > 0) {
-                        const tagsPropPath = await createData(`${(0, utils_1.docuHash)(`tags-list-${loadedVersion.versionName}-prop`)}.json`, JSON.stringify(tagsProp, null, 2));
+                        const tagsPropPath = await createData(`${(0, utils_1.docuHash)(`tags-list-${version.versionName}-prop`)}.json`, JSON.stringify(tagsProp, null, 2));
                         addRoute({
-                            path: loadedVersion.tagsPath,
+                            path: version.tagsPath,
                             exact: true,
                             component: options.docTagsListComponent,
                             modules: {
@@ -176,11 +164,12 @@ function pluginContentDocs(context, options) {
                         });
                     }
                 }
+                // TODO tags should be a sub route of the version route
                 async function createTagDocListPage(tag) {
                     const tagProps = (0, props_1.toTagDocListProp)({
-                        allTagsPath: loadedVersion.tagsPath,
+                        allTagsPath: version.tagsPath,
                         tag,
-                        docs: loadedVersion.docs,
+                        docs: version.docs,
                     });
                     const tagPropPath = await createData(`${(0, utils_1.docuHash)(`tag-${tag.permalink}`)}.json`, JSON.stringify(tagProps, null, 2));
                     addRoute({
@@ -195,34 +184,17 @@ function pluginContentDocs(context, options) {
                 await createTagsListPage();
                 await Promise.all(Object.values(versionTags).map(createTagDocListPage));
             }
-            async function doCreateVersionRoutes(loadedVersion) {
-                await createVersionTagsRoutes(loadedVersion);
-                const versionMetadata = (0, props_1.toVersionMetadataProp)(pluginId, loadedVersion);
-                const versionMetadataPropPath = await createData(`${(0, utils_1.docuHash)(`version-${loadedVersion.versionName}-metadata-prop`)}.json`, JSON.stringify(versionMetadata, null, 2));
-                addRoute({
-                    path: loadedVersion.versionPath,
-                    // allow matching /docs/* as well
-                    exact: false,
-                    // main docs component (DocPage)
-                    component: docLayoutComponent,
-                    // sub-routes for each doc
-                    routes: await createDocRoutes(loadedVersion.docs),
-                    modules: {
-                        versionMetadata: aliasedSource(versionMetadataPropPath),
-                    },
-                    priority: loadedVersion.routePriority,
-                });
-            }
-            async function createVersionRoutes(loadedVersion) {
-                try {
-                    return await doCreateVersionRoutes(loadedVersion);
-                }
-                catch (e) {
-                    console.error(chalk_1.default.red(`Can't create version routes for version "${loadedVersion.versionName}"`));
-                    throw e;
-                }
-            }
-            await Promise.all(loadedVersions.map(createVersionRoutes));
+            await Promise.all(loadedVersions.map((loadedVersion) => (0, routes_1.createVersionRoutes)({
+                loadedVersion,
+                docItemComponent,
+                docLayoutComponent,
+                docCategoryGeneratedIndexComponent,
+                pluginId,
+                aliasedSource,
+                actions,
+            })));
+            // TODO tags should be a sub route of the version route
+            await Promise.all(loadedVersions.map(createVersionTagsRoutes));
             setGlobalData({
                 path: (0, utils_1.normalizeUrl)([baseUrl, options.routeBasePath]),
                 versions: loadedVersions.map(globalData_1.toGlobalDataVersion),

package/lib/options.js

@@ -21,6 +21,7 @@ exports.DEFAULT_OPTIONS = {
     docItemComponent: '@theme/DocItem',
     docTagDocListComponent: '@theme/DocTagDocListPage',
     docTagsListComponent: '@theme/DocTagsListPage',
+    docCategoryGeneratedIndexComponent: '@theme/DocCategoryGeneratedIndexPage',
     remarkPlugins: [],
     rehypePlugins: [],
     beforeDefaultRemarkPlugins: [],
@@ -75,6 +76,7 @@ exports.OptionsSchema = utils_validation_1.Joi.object({
     docItemComponent: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.docItemComponent),
     docTagsListComponent: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.docTagsListComponent),
     docTagDocListComponent: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.docTagDocListComponent),
+    docCategoryGeneratedIndexComponent: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.docCategoryGeneratedIndexComponent),
     remarkPlugins: utils_validation_1.RemarkPluginsSchema.default(exports.DEFAULT_OPTIONS.remarkPlugins),
     rehypePlugins: utils_validation_1.RehypePluginsSchema.default(exports.DEFAULT_OPTIONS.rehypePlugins),
     beforeDefaultRemarkPlugins: utils_validation_1.RemarkPluginsSchema.default(exports.DEFAULT_OPTIONS.beforeDefaultRemarkPlugins),

package/lib/props.js

@@ -8,16 +8,20 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toTagDocListProp = exports.toVersionMetadataProp = exports.toSidebarsProp = void 0;
 const lodash_1 = require("lodash");
+const docs_1 = require("./docs");
 function toSidebarsProp(loadedVersion) {
-    const docsById = (0, lodash_1.keyBy)(loadedVersion.docs, (doc) => doc.id);
-    const convertDocLink = (item) => {
-        const docId = item.id;
+    const docsById = (0, docs_1.createDocsByIdIndex)(loadedVersion.docs);
+    function getDocById(docId) {
         const docMetadata = docsById[docId];
         if (!docMetadata) {
             throw new Error(`Invalid sidebars file. The document with id "${docId}" was used in the sidebar, but no document with this id could be found.
 Available document ids are:
 - ${Object.keys(docsById).sort().join('\n- ')}`);
         }
+        return docMetadata;
+    }
+    const convertDocLink = (item) => {
+        const docMetadata = getDocById(item.id);
         const { title, permalink, frontMatter: { sidebar_label: sidebarLabel }, } = docMetadata;
         return {
             type: 'link',
@@ -25,12 +29,28 @@ Available document ids are:
             href: permalink,
             className: item.className,
             customProps: item.customProps,
+            docId: docMetadata.unversionedId,
         };
     };
-    const normalizeItem = (item) => {
+    function getCategoryLinkHref(link) {
+        switch (link === null || link === void 0 ? void 0 : link.type) {
+            case 'doc':
+                return getDocById(link.id).permalink;
+            case 'generated-index':
+                return link.permalink;
+            default:
+                return undefined;
+        }
+    }
+    function convertCategory(item) {
+        const { link, ...rest } = item;
+        const href = getCategoryLinkHref(link);
+        return { ...rest, items: item.items.map(normalizeItem), ...(href && { href }) };
+    }
+    function normalizeItem(item) {
         switch (item.type) {
             case 'category':
-                return { ...item, items: item.items.map(normalizeItem) };
+                return convertCategory(item);
             case 'ref':
             case 'doc':
                 return convertDocLink(item);
@@ -38,13 +58,21 @@ Available document ids are:
             default:
                 return item;
         }
-    };
+    }
     // Transform the sidebar so that all sidebar item will be in the
     // form of 'link' or 'category' only.
     // This is what will be passed as props to the UI component.
     return (0, lodash_1.mapValues)(loadedVersion.sidebars, (items) => items.map(normalizeItem));
 }
 exports.toSidebarsProp = toSidebarsProp;
+function toVersionDocsProp(loadedVersion) {
+    return (0, lodash_1.mapValues)((0, lodash_1.keyBy)(loadedVersion.docs, (doc) => doc.unversionedId), (doc) => ({
+        id: doc.unversionedId,
+        title: doc.title,
+        description: doc.description,
+        sidebar: doc.sidebar,
+    }));
+}
 function toVersionMetadataProp(pluginId, loadedVersion) {
     return {
         pluginId,
@@ -55,6 +83,7 @@ function toVersionMetadataProp(pluginId, loadedVersion) {
         className: loadedVersion.versionClassName,
         isLast: loadedVersion.isLast,
         docsSidebars: toSidebarsProp(loadedVersion),
+        docs: toVersionDocsProp(loadedVersion),
     };
 }
 exports.toVersionMetadataProp = toVersionMetadataProp;

package/lib/routes.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 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 { PluginContentLoadedActions, RouteConfig } from '@docusaurus/types';
+import { DocMetadata, LoadedVersion } from './types';
+export declare function createCategoryGeneratedIndexRoutes({ version, actions, docCategoryGeneratedIndexComponent, }: {
+    version: LoadedVersion;
+    actions: PluginContentLoadedActions;
+    docCategoryGeneratedIndexComponent: string;
+}): Promise<RouteConfig[]>;
+export declare function createDocRoutes({ docs, actions, docItemComponent, }: {
+    docs: DocMetadata[];
+    actions: PluginContentLoadedActions;
+    docItemComponent: string;
+}): Promise<RouteConfig[]>;
+export declare function createVersionRoutes({ loadedVersion, actions, docItemComponent, docLayoutComponent, docCategoryGeneratedIndexComponent, pluginId, aliasedSource, }: {
+    loadedVersion: LoadedVersion;
+    actions: PluginContentLoadedActions;
+    docLayoutComponent: string;
+    docItemComponent: string;
+    docCategoryGeneratedIndexComponent: string;
+    pluginId: string;
+    aliasedSource: (str: string) => string;
+}): Promise<void>;

package/lib/routes.js

@@ -0,0 +1,105 @@
+"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.createVersionRoutes = exports.createDocRoutes = exports.createCategoryGeneratedIndexRoutes = void 0;
+const tslib_1 = require("tslib");
+const utils_1 = require("@docusaurus/utils");
+const props_1 = require("./props");
+const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+async function createCategoryGeneratedIndexRoutes({ version, actions, docCategoryGeneratedIndexComponent, }) {
+    const slugs = (0, utils_1.createSlugger)();
+    async function createCategoryGeneratedIndexRoute(categoryGeneratedIndex) {
+        const { sidebar, title, description, slug, permalink, previous, next } = categoryGeneratedIndex;
+        const propFileName = slugs.slug(`${version.versionPath}-${categoryGeneratedIndex.sidebar}-category-${categoryGeneratedIndex.title}`);
+        const prop = {
+            title,
+            description,
+            slug,
+            permalink,
+            navigation: {
+                previous,
+                next,
+            },
+        };
+        const propData = await actions.createData(`${(0, utils_1.docuHash)(`category/${propFileName}`)}.json`, JSON.stringify(prop, null, 2));
+        return {
+            path: permalink,
+            component: docCategoryGeneratedIndexComponent,
+            exact: true,
+            modules: {
+                categoryGeneratedIndex: propData,
+            },
+            // Same as doc, this sidebar route attribute permits to associate this subpage to the given sidebar
+            ...(sidebar && { sidebar }),
+        };
+    }
+    return Promise.all(version.categoryGeneratedIndices.map(createCategoryGeneratedIndexRoute));
+}
+exports.createCategoryGeneratedIndexRoutes = createCategoryGeneratedIndexRoutes;
+async function createDocRoutes({ docs, actions, docItemComponent, }) {
+    return Promise.all(docs.map(async (metadataItem) => {
+        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));
+        const docRoute = {
+            path: metadataItem.permalink,
+            component: docItemComponent,
+            exact: true,
+            modules: {
+                content: metadataItem.source,
+            },
+            // Because the parent (DocPage) 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,
+            }),
+        };
+        return docRoute;
+    }));
+}
+exports.createDocRoutes = createDocRoutes;
+async function createVersionRoutes({ loadedVersion, actions, docItemComponent, docLayoutComponent, docCategoryGeneratedIndexComponent, pluginId, aliasedSource, }) {
+    async function doCreateVersionRoutes(version) {
+        const versionMetadata = (0, props_1.toVersionMetadataProp)(pluginId, version);
+        const versionMetadataPropPath = await actions.createData(`${(0, utils_1.docuHash)(`version-${version.versionName}-metadata-prop`)}.json`, JSON.stringify(versionMetadata, null, 2));
+        async function createVersionSubRoutes() {
+            const [docRoutes, sidebarsRoutes] = await Promise.all([
+                createDocRoutes({ docs: version.docs, actions, docItemComponent }),
+                createCategoryGeneratedIndexRoutes({
+                    version,
+                    actions,
+                    docCategoryGeneratedIndexComponent,
+                }),
+            ]);
+            const routes = [...docRoutes, ...sidebarsRoutes];
+            return routes.sort((a, b) => a.path.localeCompare(b.path));
+        }
+        actions.addRoute({
+            path: version.versionPath,
+            // allow matching /docs/* as well
+            exact: false,
+            // main docs component (DocPage)
+            component: docLayoutComponent,
+            // sub-routes for each doc
+            routes: await createVersionSubRoutes(),
+            modules: {
+                versionMetadata: aliasedSource(versionMetadataPropPath),
+            },
+            priority: version.routePriority,
+        });
+    }
+    try {
+        return await doCreateVersionRoutes(loadedVersion);
+    }
+    catch (e) {
+        console.error(chalk_1.default.red(`Can't create version routes for version "${loadedVersion.versionName}"`));
+        throw e;
+    }
+}
+exports.createVersionRoutes = createVersionRoutes;

package/lib/sidebars/generator.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 { SidebarItemsGenerator } from './types';
+import type { SidebarItemsGenerator, SidebarItemCategoryLinkConfig } from './types';
 export declare const CategoryMetadataFilenameBase = "_category_";
 export declare const CategoryMetadataFilenamePattern = "_category_.{json,yml,yaml}";
 export declare type CategoryMetadataFile = {
@@ -13,5 +13,6 @@ export declare type CategoryMetadataFile = {
     collapsed?: boolean;
     collapsible?: boolean;
     className?: string;
+    link?: SidebarItemCategoryLinkConfig;
 };
 export declare const DefaultSidebarItemsGenerator: SidebarItemsGenerator;