@docusaurus/plugin-content-docs 2.0.0-beta.17 → 2.0.0-beta.18

package/lib/sidebars/types.d.ts

@@ -8,12 +8,16 @@ import type { Optional, Required } from 'utility-types';
 import type { DocMetadataBase, VersionMetadata } from '../types';
 import type { NumberPrefixParser, SidebarOptions, CategoryIndexMatcher } from '@docusaurus/plugin-content-docs';
 import type { Slugger } from '@docusaurus/utils';
-declare type Expand<T extends Record<string, unknown>> = {
+declare type Expand<T extends {
+    [x: string]: unknown;
+}> = {
     [P in keyof T]: T[P];
 };
 export declare type SidebarItemBase = {
     className?: string;
-    customProps?: Record<string, unknown>;
+    customProps?: {
+        [key: string]: unknown;
+    };
 };
 export declare type SidebarItemDoc = SidebarItemBase & {
     type: 'doc' | 'ref';
@@ -138,8 +142,11 @@ export declare type CategoryMetadataFile = {
     collapsible?: boolean;
     className?: string;
     link?: SidebarItemCategoryLinkConfig | null;
+    customProps?: {
+        [key: string]: unknown;
+    };
 };
-export declare type SidebarItemsGeneratorDoc = Pick<DocMetadataBase, 'id' | 'unversionedId' | 'frontMatter' | 'source' | 'sourceDirName' | 'sidebarPosition'>;
+export declare type SidebarItemsGeneratorDoc = Pick<DocMetadataBase, 'id' | 'unversionedId' | 'title' | 'frontMatter' | 'source' | 'sourceDirName' | 'sidebarPosition'>;
 export declare type SidebarItemsGeneratorVersion = Pick<VersionMetadata, 'versionName' | 'contentPath'>;
 export declare type SidebarItemsGeneratorArgs = {
     item: SidebarItemAutogenerated;
@@ -147,8 +154,9 @@ export declare type SidebarItemsGeneratorArgs = {
     docs: SidebarItemsGeneratorDoc[];
     numberPrefixParser: NumberPrefixParser;
     isCategoryIndex: CategoryIndexMatcher;
-    categoriesMetadata: Record<string, CategoryMetadataFile>;
-    options: SidebarOptions;
+    categoriesMetadata: {
+        [filePath: string]: CategoryMetadataFile;
+    };
 };
 export declare type SidebarItemsGenerator = (generatorArgs: SidebarItemsGeneratorArgs) => Promise<NormalizedSidebar>;
 export declare type SidebarItemsGeneratorOptionArgs = {

package/lib/sidebars/utils.d.ts

@@ -13,8 +13,12 @@ export declare function collectSidebarCategories(sidebar: Sidebar): SidebarItemC
 export declare function collectSidebarLinks(sidebar: Sidebar): SidebarItemLink[];
 export declare function collectSidebarDocIds(sidebar: Sidebar): string[];
 export declare function collectSidebarNavigation(sidebar: Sidebar): SidebarNavigationItem[];
-export declare function collectSidebarsDocIds(sidebars: Sidebars): Record<string, string[]>;
-export declare function collectSidebarsNavigations(sidebars: Sidebars): Record<string, SidebarNavigationItem[]>;
+export declare function collectSidebarsDocIds(sidebars: Sidebars): {
+    [sidebarId: string]: string[];
+};
+export declare function collectSidebarsNavigations(sidebars: Sidebars): {
+    [sidebarId: string]: SidebarNavigationItem[];
+};
 export declare type SidebarNavigation = {
     sidebarName: string | undefined;
     previous: SidebarNavigationItem | undefined;
@@ -27,17 +31,24 @@ export declare type SidebarsUtils = {
     getDocNavigation: (unversionedId: string, versionedId: string, displayedSidebar: string | null | undefined) => SidebarNavigation;
     getCategoryGeneratedIndexList: () => SidebarItemCategoryWithGeneratedIndex[];
     getCategoryGeneratedIndexNavigation: (categoryGeneratedIndexPermalink: string) => SidebarNavigation;
+    /**
+     * This function may return undefined. This is usually a user mistake, because
+     * it means this sidebar will never be displayed; however, we can still use
+     * `displayed_sidebar` to make it displayed. Pretty weird but valid use-case
+     */
     getFirstLink: (sidebarId: string) => {
         type: 'doc';
         id: string;
         label: string;
     } | {
         type: 'generated-index';
-        slug: string;
+        permalink: string;
         label: string;
     } | undefined;
     checkSidebarsDocIds: (validDocIds: string[], sidebarFilePath: string) => void;
 };
 export declare function createSidebarsUtils(sidebars: Sidebars): SidebarsUtils;
 export declare function toDocNavigationLink(doc: DocMetadataBase): DocNavLink;
-export declare function toNavigationLink(navigationItem: SidebarNavigationItem | undefined, docsById: Record<string, DocMetadataBase>): DocNavLink | undefined;
+export declare function toNavigationLink(navigationItem: SidebarNavigationItem | undefined, docsById: {
+    [docId: string]: DocMetadataBase;
+}): DocNavLink | undefined;

package/lib/sidebars/utils.js

@@ -119,10 +119,10 @@ function createSidebarsUtils(sidebars) {
         if (!sidebarName) {
             return emptySidebarNavigation();
         }
-        if (!sidebarNameToNavigationItems[sidebarName]) {
+        const navigationItems = sidebarNameToNavigationItems[sidebarName];
+        if (!navigationItems) {
             throw new Error(`Doc with ID ${docId} wants to display sidebar ${sidebarName} but a sidebar with this name doesn't exist`);
         }
-        const navigationItems = sidebarNameToNavigationItems[sidebarName];
         const currentItemIndex = navigationItems.findIndex((item) => {
             if (item.type === 'doc') {
                 return item.id === docId;
@@ -135,8 +135,11 @@ function createSidebarsUtils(sidebars) {
         if (currentItemIndex === -1) {
             return { sidebarName, next: undefined, previous: undefined };
         }
-        const { previous, next } = (0, utils_1.getElementsAround)(navigationItems, currentItemIndex);
-        return { sidebarName, previous, next };
+        return {
+            sidebarName,
+            previous: navigationItems[currentItemIndex - 1],
+            next: navigationItems[currentItemIndex + 1],
+        };
     }
     function getCategoryGeneratedIndexList() {
         return Object.values(sidebarNameToNavigationItems)
@@ -158,14 +161,14 @@ function createSidebarsUtils(sidebars) {
                 item.link?.type === 'generated-index' &&
                 item.link.permalink === categoryGeneratedIndexPermalink);
         }
-        const sidebarName = Object.entries(sidebarNameToNavigationItems).find(([, navigationItems]) => navigationItems.find(isCurrentCategoryGeneratedIndexItem))?.[0];
-        if (!sidebarName) {
-            return emptySidebarNavigation();
-        }
+        const sidebarName = Object.entries(sidebarNameToNavigationItems).find(([, navigationItems]) => navigationItems.find(isCurrentCategoryGeneratedIndexItem))[0];
         const navigationItems = sidebarNameToNavigationItems[sidebarName];
         const currentItemIndex = navigationItems.findIndex(isCurrentCategoryGeneratedIndexItem);
-        const { previous, next } = (0, utils_1.getElementsAround)(navigationItems, currentItemIndex);
-        return { sidebarName, previous, next };
+        return {
+            sidebarName,
+            previous: navigationItems[currentItemIndex - 1],
+            next: navigationItems[currentItemIndex + 1],
+        };
     }
     function checkSidebarsDocIds(validDocIds, sidebarFilePath) {
         const allSidebarDocIds = Object.values(sidebarNameToDocIds).flat();
@@ -199,7 +202,7 @@ Available document ids are:
                 else if (item.link?.type === 'generated-index') {
                     return {
                         type: 'generated-index',
-                        slug: item.link.slug,
+                        permalink: item.link.permalink,
                         label: item.label,
                     };
                 }
@@ -239,21 +242,14 @@ function toNavigationLink(navigationItem, docsById) {
     if (!navigationItem) {
         return undefined;
     }
-    if (navigationItem.type === 'doc') {
-        return toDocNavigationLink(getDocById(navigationItem.id));
-    }
-    else if (navigationItem.type === 'category') {
-        if (navigationItem.link.type === 'doc') {
-            return toDocNavigationLink(getDocById(navigationItem.link.id));
-        }
-        else if (navigationItem.link.type === 'generated-index') {
-            return {
+    if (navigationItem.type === 'category') {
+        return navigationItem.link.type === 'doc'
+            ? toDocNavigationLink(getDocById(navigationItem.link.id))
+            : {
                 title: navigationItem.label,
                 permalink: navigationItem.link.permalink,
             };
-        }
-        throw new Error('unexpected category link type');
     }
-    throw new Error('unexpected navigation item');
+    return toDocNavigationLink(getDocById(navigationItem.id));
 }
 exports.toNavigationLink = toNavigationLink;

package/lib/sidebars/validation.d.ts

@@ -5,5 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { NormalizedSidebars, CategoryMetadataFile } from './types';
-export declare function validateSidebars(sidebars: Record<string, unknown>): asserts sidebars is NormalizedSidebars;
+export declare function validateSidebars(sidebars: {
+    [sidebarId: string]: unknown;
+}): asserts sidebars is NormalizedSidebars;
 export declare function validateCategoryMetadataFile(unsafeContent: unknown): CategoryMetadataFile;

package/lib/sidebars/validation.js

@@ -130,6 +130,7 @@ const categoryMetadataFileSchema = utils_validation_1.Joi.object({
     collapsible: utils_validation_1.Joi.boolean(),
     className: utils_validation_1.Joi.string(),
     link: sidebarItemCategoryLinkSchema,
+    customProps: utils_validation_1.Joi.object().unknown(),
 });
 function validateCategoryMetadataFile(unsafeContent) {
     return utils_validation_1.Joi.attempt(unsafeContent, categoryMetadataFileSchema);

package/lib/slug.js

@@ -33,12 +33,11 @@ function getSlug({ baseID, frontMatterSlug, source, sourceDirName, stripDirNumbe
     }
     function ensureValidSlug(slug) {
         if (!(0, utils_1.isValidPathname)(slug)) {
-            throw new Error(`We couldn't compute a valid slug for document with id "${baseID}" in "${sourceDirName}" directory.
+            throw new Error(`We couldn't compute a valid slug for document with ID "${baseID}" in "${sourceDirName}" directory.
 The slug we computed looks invalid: ${slug}.
-Maybe your slug front matter is incorrect or you use weird chars in the file path?
-By using the slug front matter, you should be able to fix this error, by using the slug of your choice:
+Maybe your slug front matter is incorrect or there are special characters in the file path?
+By using front matter to set a custom slug, you should be able to fix this error:
 
-Example =>
 ---
 slug: /my/customDocPath
 ---

package/lib/translations.js

@@ -84,26 +84,24 @@ function getSidebarTranslationFileContent(sidebar, sidebarName) {
                 description: `The label for category ${category.label} in sidebar ${sidebarName}`,
             },
         ]);
-        if (category.link) {
-            if (category.link.type === 'generated-index') {
-                if (category.link.title) {
-                    entries.push([
-                        `sidebar.${sidebarName}.category.${category.label}.link.generated-index.title`,
-                        {
-                            message: category.link.title,
-                            description: `The generated-index page title for category ${category.label} in sidebar ${sidebarName}`,
-                        },
-                    ]);
-                }
-                if (category.link.description) {
-                    entries.push([
-                        `sidebar.${sidebarName}.category.${category.label}.link.generated-index.description`,
-                        {
-                            message: category.link.description,
-                            description: `The generated-index page description for category ${category.label} in sidebar ${sidebarName}`,
-                        },
-                    ]);
-                }
+        if (category.link?.type === 'generated-index') {
+            if (category.link.title) {
+                entries.push([
+                    `sidebar.${sidebarName}.category.${category.label}.link.generated-index.title`,
+                    {
+                        message: category.link.title,
+                        description: `The generated-index page title for category ${category.label} in sidebar ${sidebarName}`,
+                    },
+                ]);
+            }
+            if (category.link.description) {
+                entries.push([
+                    `sidebar.${sidebarName}.category.${category.label}.link.generated-index.description`,
+                    {
+                        message: category.link.description,
+                        description: `The generated-index page description for category ${category.label} in sidebar ${sidebarName}`,
+                    },
+                ]);
             }
         }
         return entries;
@@ -198,7 +196,7 @@ function translateVersion(version, translationFiles) {
     const versionTranslations = translationFiles[getVersionFileName(version.versionName)].content;
     return {
         ...version,
-        versionLabel: versionTranslations['version.label']?.message,
+        versionLabel: versionTranslations['version.label']?.message ?? version.versionLabel,
         sidebars: translateSidebars(version, versionTranslations),
         // docs: translateDocs(version.docs, versionTranslations),
     };

package/lib/types.d.ts

@@ -5,8 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { Sidebars } from './sidebars/types';
-import type { Tag, FrontMatterTag } from '@docusaurus/utils';
-import type { BrokenMarkdownLink as IBrokenMarkdownLink, ContentPaths } from '@docusaurus/utils/lib/markdownLinks';
+import type { Tag, FrontMatterTag, BrokenMarkdownLink, ContentPaths } from '@docusaurus/utils';
 import type { VersionBanner } from '@docusaurus/plugin-content-docs';
 export declare type DocFile = {
     contentPath: string;
@@ -47,7 +46,9 @@ export declare type DocFrontMatter = {
     sidebar_label?: string;
     sidebar_position?: number;
     sidebar_class_name?: string;
-    sidebar_custom_props?: Record<string, unknown>;
+    sidebar_custom_props?: {
+        [key: string]: unknown;
+    };
     displayed_sidebar?: string | null;
     pagination_label?: string;
     custom_edit_url?: string | null;
@@ -70,7 +71,9 @@ export declare type DocMetadataBase = LastUpdateData & {
     sidebarPosition?: number;
     editUrl?: string | null;
     tags: Tag[];
-    frontMatter: DocFrontMatter & Record<string, unknown>;
+    frontMatter: DocFrontMatter & {
+        [key: string]: unknown;
+    };
 };
 export declare type DocNavLink = {
     title: string;
@@ -113,10 +116,10 @@ export declare type LoadedVersion = VersionMetadata & {
 export declare type LoadedContent = {
     loadedVersions: LoadedVersion[];
 };
-export declare type BrokenMarkdownLink = IBrokenMarkdownLink<VersionMetadata>;
+export declare type DocBrokenMarkdownLink = BrokenMarkdownLink<VersionMetadata>;
 export declare type DocsMarkdownOption = {
     versionsMetadata: VersionMetadata[];
     siteDir: string;
     sourceToPermalink: SourceToPermalink;
-    onBrokenMarkdownLink: (brokenMarkdownLink: BrokenMarkdownLink) => void;
+    onBrokenMarkdownLink: (brokenMarkdownLink: DocBrokenMarkdownLink) => void;
 };

package/lib/versions.js

@@ -42,8 +42,8 @@ function ensureValidVersionString(version) {
     }
 }
 function ensureValidVersionArray(versionArray) {
-    if (!(versionArray instanceof Array)) {
-        throw new Error(`The versions file should contain an array of versions! Found content: ${JSON.stringify(versionArray)}`);
+    if (!Array.isArray(versionArray)) {
+        throw new Error(`The versions file should contain an array of version names! Found content: ${JSON.stringify(versionArray)}`);
     }
     versionArray.forEach(ensureValidVersionString);
 }
@@ -294,7 +294,7 @@ function checkVersionsOptions(availableVersionNames, options) {
  */
 function filterVersions(versionNamesUnfiltered, options) {
     if (options.onlyIncludeVersions) {
-        return versionNamesUnfiltered.filter((name) => (options.onlyIncludeVersions || []).includes(name));
+        return versionNamesUnfiltered.filter((name) => options.onlyIncludeVersions.includes(name));
     }
     return versionNamesUnfiltered;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "2.0.0-beta.17",
+  "version": "2.0.0-beta.18",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "exports": {
@@ -23,11 +23,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.17",
-    "@docusaurus/logger": "2.0.0-beta.17",
-    "@docusaurus/mdx-loader": "2.0.0-beta.17",
-    "@docusaurus/utils": "2.0.0-beta.17",
-    "@docusaurus/utils-validation": "2.0.0-beta.17",
+    "@docusaurus/core": "2.0.0-beta.18",
+    "@docusaurus/logger": "2.0.0-beta.18",
+    "@docusaurus/mdx-loader": "2.0.0-beta.18",
+    "@docusaurus/utils": "2.0.0-beta.18",
+    "@docusaurus/utils-validation": "2.0.0-beta.18",
     "combine-promises": "^1.1.0",
     "fs-extra": "^10.0.1",
     "import-fresh": "^3.3.0",
@@ -36,11 +36,11 @@
     "remark-admonitions": "^1.2.1",
     "tslib": "^2.3.1",
     "utility-types": "^3.10.0",
-    "webpack": "^5.69.1"
+    "webpack": "^5.70.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.0.0-beta.17",
-    "@docusaurus/types": "2.0.0-beta.17",
+    "@docusaurus/module-type-aliases": "2.0.0-beta.18",
+    "@docusaurus/types": "2.0.0-beta.18",
     "@types/js-yaml": "^4.0.5",
     "@types/picomatch": "^2.3.0",
     "commander": "^5.1.0",
@@ -56,5 +56,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "0032c0b0480083227af2e1b4da2d3ee6ce992403"
+  "gitHead": "1a945d06993d53376e61bed2c942799fe07dc336"
 }

package/src/categoryGeneratedIndex.ts

@@ -17,14 +17,10 @@ function getCategoryGeneratedIndexMetadata({
 }: {
   category: SidebarItemCategoryWithGeneratedIndex;
   sidebarsUtils: SidebarsUtils;
-  docsById: Record<string, DocMetadataBase>;
+  docsById: {[docId: string]: DocMetadataBase};
 }): CategoryGeneratedIndexMetadata {
   const {sidebarName, previous, next} =
     sidebarsUtils.getCategoryGeneratedIndexNavigation(category.link.permalink);
-  if (!sidebarName) {
-    throw new Error('unexpected');
-  }
-
   return {
     title: category.link.title ?? category.label,
     description: category.link.description,
@@ -32,7 +28,7 @@ function getCategoryGeneratedIndexMetadata({
     keywords: category.link.keywords,
     slug: category.link.slug,
     permalink: category.link.permalink,
-    sidebar: sidebarName,
+    sidebar: sidebarName!,
     previous: toNavigationLink(previous, docsById),
     next: toNavigationLink(next, docsById),
   };

package/src/cli.ts

@@ -47,8 +47,7 @@ async function createVersionedSidebarFile({
       versionedSidebarsDir,
       `version-${version}-sidebars.json`,
     );
-    await fs.ensureDir(path.dirname(newSidebarFile));
-    await fs.writeFile(
+    await fs.outputFile(
       newSidebarFile,
       `${JSON.stringify(sidebars, null, 2)}\n`,
       'utf8',
@@ -89,7 +88,7 @@ export async function cliDocsVersionCommand(
   // Since we are going to create `version-${version}` folder, we need to make
   // sure it's a valid pathname.
   // eslint-disable-next-line no-control-regex
-  if (/[<>:"|?*\x00-\x1F]/g.test(version)) {
+  if (/[<>:"|?*\x00-\x1F]/.test(version)) {
     throw new Error(
       `${pluginIdLogPrefix}: invalid version tag specified! Please ensure its a valid pathname too. Try something like: 1.0.0.`,
     );
@@ -140,8 +139,7 @@ export async function cliDocsVersionCommand(
 
   // Update versions.json file.
   versions.unshift(version);
-  await fs.ensureDir(path.dirname(versionsJSONFile));
-  await fs.writeFile(
+  await fs.outputFile(
     versionsJSONFile,
     `${JSON.stringify(versions, null, 2)}\n`,
   );

package/src/client/docsClientUtils.ts

@@ -23,11 +23,11 @@ import type {
 // ie the docs of that plugin are currently browsed
 // it is useful to support multiple docs plugin instances
 export function getActivePlugin(
-  allPluginDatas: Record<string, GlobalPluginData>,
+  allPluginData: {[pluginId: string]: GlobalPluginData},
   pathname: string,
   options: GetActivePluginOptions = {},
 ): ActivePlugin | undefined {
-  const activeEntry = Object.entries(allPluginDatas)
+  const activeEntry = Object.entries(allPluginData)
     // Route sorting: '/android/foo' should match '/android' instead of '/'
     .sort((a, b) => b[1].path.localeCompare(a[1].path))
     .find(
@@ -46,7 +46,7 @@ export function getActivePlugin(
   if (!activePlugin && options.failfast) {
     throw new Error(
       `Can't find active docs plugin for "${pathname}" pathname, while it was expected to be found. Maybe you tried to use a docs feature that can only be used on a docs-related page? Existing docs plugin paths are: ${Object.values(
-        allPluginDatas,
+        allPluginData,
       )
         .map((plugin) => plugin.path)
         .join(', ')}`,

package/src/client/index.ts

@@ -31,7 +31,7 @@ const StableEmptyObject = {};
 // Not using useAllPluginInstancesData() because 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 = (): Record<string, GlobalPluginData> =>
+export const useAllDocsData = (): {[pluginId: string]: GlobalPluginData} =>
   useGlobalData()['docusaurus-plugin-content-docs'] ?? StableEmptyObject;
 
 export const useDocsData = (pluginId: string | undefined): GlobalPluginData =>

package/src/deps.d.ts

@@ -6,7 +6,7 @@
  */
 
 declare module 'remark-admonitions' {
-  type Options = Record<string, unknown>;
+  type Options = {[key: string]: unknown};
 
   const plugin: (options?: Options) => void;
   export = plugin;

package/src/docs.ts

@@ -34,7 +34,7 @@ import getSlug from './slug';
 import {CURRENT_VERSION_NAME} from './constants';
 import {getDocsDirPaths} from './versions';
 import {stripPathNumberPrefixes} from './numberPrefix';
-import {validateDocFrontMatter} from './docFrontMatter';
+import {validateDocFrontMatter} from './frontMatter';
 import type {SidebarsUtils} from './sidebars/utils';
 import {toDocNavigationLink, toNavigationLink} from './sidebars/utils';
 import type {
@@ -363,7 +363,7 @@ export function getMainDocId({
           doc.unversionedId === firstDocIdOfFirstSidebar,
       )!;
     }
-    return docs[0];
+    return docs[0]!;
   }
 
   return getMainDoc().unversionedId;
@@ -391,6 +391,10 @@ export const isCategoryIndex: CategoryIndexMatcher = ({
   return eligibleDocIndexNames.includes(fileName.toLowerCase());
 };
 
+/**
+ * `guides/sidebar/autogenerated.md` ->
+ *   `'autogenerated', '.md', ['sidebar', 'guides']`
+ */
 export function toCategoryIndexMatcherParam({
   source,
   sourceDirName,
@@ -406,28 +410,6 @@ export function toCategoryIndexMatcherParam({
   };
 }
 
-/**
- * `guides/sidebar/autogenerated.md` ->
- *   `'autogenerated', '.md', ['sidebar', 'guides']`
- */
-export function splitPath(str: string): {
-  /**
-   * The list of directories, from lowest level to highest.
-   * If there's no dir name, directories is ['.']
-   */
-  directories: string[];
-  /** The file name, without extension */
-  fileName: string;
-  /** The extension, with a leading dot */
-  extension: string;
-} {
-  return {
-    fileName: path.parse(str).name,
-    extension: path.parse(str).ext,
-    directories: path.dirname(str).split(path.sep).reverse(),
-  };
-}
-
 // 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
@@ -442,7 +424,7 @@ export function getDocIds(doc: DocMetadataBase): [string, string] {
 // to "id")
 export function createDocsByIdIndex<
   Doc extends {id: string; unversionedId: string},
->(docs: Doc[]): Record<string, Doc> {
+>(docs: Doc[]): {[docId: string]: Doc} {
   return Object.fromEntries(
     docs.flatMap((doc) => [
       [doc.unversionedId, doc],

package/src/{docFrontMatter.ts → frontMatter.ts}

@@ -25,7 +25,7 @@ const DocFrontMatterSchema = Joi.object<DocFrontMatter>({
   hide_table_of_contents: Joi.boolean(),
   keywords: Joi.array().items(Joi.string().required()),
   image: URISchema,
-  description: Joi.string().allow(''), // see  https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
+  description: Joi.string().allow(''), // see https://github.com/facebook/docusaurus/issues/4591#issuecomment-822372398
   slug: Joi.string(),
   sidebar_label: Joi.string(),
   sidebar_position: Joi.number(),
@@ -41,8 +41,8 @@ const DocFrontMatterSchema = Joi.object<DocFrontMatter>({
   ...FrontMatterTOCHeadingLevels,
 }).unknown();
 
-export function validateDocFrontMatter(
-  frontMatter: Record<string, unknown>,
-): DocFrontMatter {
+export function validateDocFrontMatter(frontMatter: {
+  [key: string]: unknown;
+}): DocFrontMatter {
   return validateFrontMatter(frontMatter, DocFrontMatterSchema);
 }

package/src/globalData.ts

@@ -6,7 +6,6 @@
  */
 
 import _ from 'lodash';
-import {normalizeUrl} from '@docusaurus/utils';
 import type {Sidebars} from './sidebars/types';
 import {createSidebarsUtils} from './sidebars/utils';
 import type {
@@ -20,7 +19,7 @@ import type {
   GlobalDoc,
 } from '@docusaurus/plugin-content-docs/client';
 
-export function toGlobalDataDoc(doc: DocMetadata): GlobalDoc {
+function toGlobalDataDoc(doc: DocMetadata): GlobalDoc {
   return {
     id: doc.unversionedId,
     path: doc.permalink,
@@ -28,7 +27,7 @@ export function toGlobalDataDoc(doc: DocMetadata): GlobalDoc {
   };
 }
 
-export function toGlobalDataGeneratedIndex(
+function toGlobalDataGeneratedIndex(
   doc: CategoryGeneratedIndexMetadata,
 ): GlobalDoc {
   return {
@@ -38,10 +37,10 @@ export function toGlobalDataGeneratedIndex(
   };
 }
 
-export function toGlobalSidebars(
+function toGlobalSidebars(
   sidebars: Sidebars,
   version: LoadedVersion,
-): Record<string, GlobalSidebar> {
+): {[sidebarId: string]: GlobalSidebar} {
   const {getFirstLink} = createSidebarsUtils(sidebars);
   return _.mapValues(sidebars, (sidebar, sidebarId) => {
     const firstLink = getFirstLink(sidebarId);
@@ -52,7 +51,7 @@ export function toGlobalSidebars(
       link: {
         path:
           firstLink.type === 'generated-index'
-            ? normalizeUrl([version.versionPath, firstLink.slug])
+            ? firstLink.permalink
             : version.docs.find(
                 (doc) =>
                   doc.id === firstLink.id || doc.unversionedId === firstLink.id,

package/src/index.ts

@@ -56,7 +56,6 @@ import type {
   PropTagsListPage,
   PluginOptions,
 } from '@docusaurus/plugin-content-docs';
-import type {GlobalPluginData} from '@docusaurus/plugin-content-docs/client';
 import {createSidebarsUtils} from './sidebars/utils';
 import {getCategoryGeneratedIndexMetadataList} from './categoryGeneratedIndex';
 
@@ -293,7 +292,7 @@ export default async function pluginContentDocs(
       // TODO tags should be a sub route of the version route
       await Promise.all(loadedVersions.map(createVersionTagsRoutes));
 
-      setGlobalData<GlobalPluginData>({
+      setGlobalData({
         path: normalizeUrl([baseUrl, options.routeBasePath]),
         versions: loadedVersions.map(toGlobalDataVersion),
         breadcrumbs,