@docusaurus/plugin-content-docs 2.0.0-beta.16 → 2.0.0-beta.19

package/lib/categoryGeneratedIndex.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 { CategoryGeneratedIndexMetadata, DocMetadataBase } from './types';
+import type { CategoryGeneratedIndexMetadata, DocMetadataBase } from '@docusaurus/plugin-content-docs';
 import { type SidebarsUtils } from './sidebars/utils';
 export declare function getCategoryGeneratedIndexMetadataList({ docs, sidebarsUtils, }: {
     sidebarsUtils: SidebarsUtils;

package/lib/categoryGeneratedIndex.js

@@ -10,21 +10,19 @@ exports.getCategoryGeneratedIndexMetadataList = void 0;
 const utils_1 = require("./sidebars/utils");
 const docs_1 = require("./docs");
 function getCategoryGeneratedIndexMetadata({ category, sidebarsUtils, docsById, }) {
-    var _a;
     const { sidebarName, previous, next } = sidebarsUtils.getCategoryGeneratedIndexNavigation(category.link.permalink);
-    if (!sidebarName) {
-        throw new Error('unexpected');
-    }
     return {
-        title: (_a = category.link.title) !== null && _a !== void 0 ? _a : category.label,
+        title: category.link.title ?? category.label,
         description: category.link.description,
         image: category.link.image,
         keywords: category.link.keywords,
         slug: category.link.slug,
         permalink: category.link.permalink,
         sidebar: sidebarName,
-        previous: (0, utils_1.toNavigationLink)(previous, docsById),
-        next: (0, utils_1.toNavigationLink)(next, docsById),
+        navigation: {
+            previous: (0, utils_1.toNavigationLink)(previous, docsById),
+            next: (0, utils_1.toNavigationLink)(next, docsById),
+        },
     };
 }
 function getCategoryGeneratedIndexMetadataList({ docs, sidebarsUtils, }) {

package/lib/cli.d.ts

@@ -4,5 +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 type { PathOptions, SidebarOptions } from '@docusaurus/plugin-content-docs';
-export declare function cliDocsVersionCommand(version: string | null | undefined, siteDir: string, pluginId: string, options: PathOptions & SidebarOptions): Promise<void>;
+import type { PluginOptions } from '@docusaurus/plugin-content-docs';
+import type { LoadContext } from '@docusaurus/types';
+export declare function cliDocsVersionCommand(version: string, { id: pluginId, path: docsPath, sidebarPath }: PluginOptions, { siteDir, i18n }: LoadContext): Promise<void>;

package/lib/cli.js

@@ -8,12 +8,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.cliDocsVersionCommand = void 0;
 const tslib_1 = require("tslib");
-const versions_1 = require("./versions");
-const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
-const path_1 = (0, tslib_1.__importDefault)(require("path"));
+const files_1 = require("./versions/files");
+const validation_1 = require("./versions/validation");
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const path_1 = tslib_1.__importDefault(require("path"));
 const sidebars_1 = require("./sidebars");
+const constants_1 = require("./constants");
 const utils_1 = require("@docusaurus/utils");
-const logger_1 = (0, tslib_1.__importDefault)(require("@docusaurus/logger"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 async function createVersionedSidebarFile({ siteDir, pluginId, sidebarPath, version, }) {
     // Load current sidebar and create a new versioned sidebars file (if needed).
     // Note: we don't need the sidebars file to be normalized: it's ok to let
@@ -24,67 +26,73 @@ async function createVersionedSidebarFile({ siteDir, pluginId, sidebarPath, vers
     // or sidebars are disabled/false)
     const shouldCreateVersionedSidebarFile = Object.keys(sidebars).length > 0;
     if (shouldCreateVersionedSidebarFile) {
-        const versionedSidebarsDir = (0, versions_1.getVersionedSidebarsDirPath)(siteDir, pluginId);
-        const newSidebarFile = path_1.default.join(versionedSidebarsDir, `version-${version}-sidebars.json`);
-        await fs_extra_1.default.ensureDir(path_1.default.dirname(newSidebarFile));
-        await fs_extra_1.default.writeFile(newSidebarFile, `${JSON.stringify(sidebars, null, 2)}\n`, 'utf8');
+        await fs_extra_1.default.outputFile((0, files_1.getVersionSidebarsPath)(siteDir, pluginId, version), `${JSON.stringify(sidebars, null, 2)}\n`, 'utf8');
     }
 }
 // Tests depend on non-default export for mocking.
-async function cliDocsVersionCommand(version, siteDir, pluginId, options) {
+async function cliDocsVersionCommand(version, { id: pluginId, path: docsPath, sidebarPath }, { siteDir, i18n }) {
     // It wouldn't be very user-friendly to show a [default] log prefix,
     // so we use [docs] instead of [default]
     const pluginIdLogPrefix = pluginId === utils_1.DEFAULT_PLUGIN_ID ? '[docs]' : `[${pluginId}]`;
-    if (!version) {
-        throw new Error(`${pluginIdLogPrefix}: no version tag specified! Pass the version you wish to create as an argument, for example: 1.0.0.`);
+    try {
+        (0, validation_1.validateVersionName)(version);
     }
-    if (version.includes('/') || version.includes('\\')) {
-        throw new Error(`${pluginIdLogPrefix}: invalid version tag specified! Do not include slash (/) or backslash (\\). Try something like: 1.0.0.`);
-    }
-    if (version.length > 32) {
-        throw new Error(`${pluginIdLogPrefix}: invalid version tag specified! Length cannot exceed 32 characters. Try something like: 1.0.0.`);
-    }
-    // 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)) {
-        throw new Error(`${pluginIdLogPrefix}: invalid version tag specified! Please ensure its a valid pathname too. Try something like: 1.0.0.`);
-    }
-    if (/^\.\.?$/.test(version)) {
-        throw new Error(`${pluginIdLogPrefix}: invalid version tag specified! Do not name your version "." or "..". Try something like: 1.0.0.`);
+    catch (e) {
+        logger_1.default.info `${pluginIdLogPrefix}: Invalid version name provided. Try something like: 1.0.0`;
+        throw e;
     }
     // Load existing versions.
     let versions = [];
-    const versionsJSONFile = (0, versions_1.getVersionsFilePath)(siteDir, pluginId);
+    const versionsJSONFile = (0, files_1.getVersionsFilePath)(siteDir, pluginId);
     if (await fs_extra_1.default.pathExists(versionsJSONFile)) {
-        versions = JSON.parse(await fs_extra_1.default.readFile(versionsJSONFile, 'utf8'));
+        versions = await fs_extra_1.default.readJSON(versionsJSONFile);
     }
     // Check if version already exists.
     if (versions.includes(version)) {
         throw new Error(`${pluginIdLogPrefix}: this version already exists! Use a version tag that does not already exist.`);
     }
-    const { path: docsPath, sidebarPath } = options;
-    // Copy docs files.
-    const docsDir = path_1.default.join(siteDir, docsPath);
-    if ((await fs_extra_1.default.pathExists(docsDir)) &&
-        (await fs_extra_1.default.readdir(docsDir)).length > 0) {
-        const versionedDir = (0, versions_1.getVersionedDocsDirPath)(siteDir, pluginId);
-        const newVersionDir = path_1.default.join(versionedDir, `version-${version}`);
-        await fs_extra_1.default.copy(docsDir, newVersionDir);
-    }
-    else {
-        throw new Error(`${pluginIdLogPrefix}: there is no docs to version!`);
+    if (i18n.locales.length > 1) {
+        logger_1.default.info `Versioned docs will be created for the following locales: name=${i18n.locales}`;
     }
+    await Promise.all(i18n.locales.map(async (locale) => {
+        // Copy docs files.
+        const docsDir = locale === i18n.defaultLocale
+            ? path_1.default.resolve(siteDir, docsPath)
+            : (0, files_1.getDocsDirPathLocalized)({
+                siteDir,
+                locale,
+                pluginId,
+                versionName: constants_1.CURRENT_VERSION_NAME,
+            });
+        if (!(await fs_extra_1.default.pathExists(docsDir)) ||
+            (await fs_extra_1.default.readdir(docsDir)).length === 0) {
+            if (locale === i18n.defaultLocale) {
+                throw new Error(logger_1.default.interpolate `${pluginIdLogPrefix}: no docs found in path=${docsDir}.`);
+            }
+            else {
+                logger_1.default.warn `${pluginIdLogPrefix}: no docs found in path=${docsDir}. Skipping.`;
+                return;
+            }
+        }
+        const newVersionDir = locale === i18n.defaultLocale
+            ? (0, files_1.getVersionDocsDirPath)(siteDir, pluginId, version)
+            : (0, files_1.getDocsDirPathLocalized)({
+                siteDir,
+                locale,
+                pluginId,
+                versionName: version,
+            });
+        await fs_extra_1.default.copy(docsDir, newVersionDir);
+    }));
     await createVersionedSidebarFile({
         siteDir,
         pluginId,
         version,
-        sidebarPath: (0, sidebars_1.resolveSidebarPathOption)(siteDir, sidebarPath),
+        sidebarPath,
     });
     // Update versions.json file.
     versions.unshift(version);
-    await fs_extra_1.default.ensureDir(path_1.default.dirname(versionsJSONFile));
-    await fs_extra_1.default.writeFile(versionsJSONFile, `${JSON.stringify(versions, null, 2)}\n`);
+    await fs_extra_1.default.outputFile(versionsJSONFile, `${JSON.stringify(versions, null, 2)}\n`);
     logger_1.default.success `name=${pluginIdLogPrefix}: version name=${version} created!`;
 }
 exports.cliDocsVersionCommand = cliDocsVersionCommand;

package/lib/client/docsClientUtils.d.ts

@@ -4,9 +4,12 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { GlobalPluginData, GlobalVersion, GetActivePluginOptions, ActivePlugin, ActiveDocContext, DocVersionSuggestions } from '@docusaurus/plugin-content-docs/client';
-export declare function getActivePlugin(allPluginDatas: Record<string, GlobalPluginData>, pathname: string, options?: GetActivePluginOptions): ActivePlugin | undefined;
+import type { GlobalPluginData, GlobalVersion, ActivePlugin, ActiveDocContext, DocVersionSuggestions } from '@docusaurus/plugin-content-docs/client';
+import type { UseDataOptions } from '@docusaurus/types';
+export declare function getActivePlugin(allPluginData: {
+    [pluginId: string]: GlobalPluginData;
+}, pathname: string, options?: UseDataOptions): ActivePlugin | undefined;
 export declare const getLatestVersion: (data: GlobalPluginData) => GlobalVersion;
-export declare const getActiveVersion: (data: GlobalPluginData, pathname: string) => GlobalVersion | undefined;
-export declare const getActiveDocContext: (data: GlobalPluginData, pathname: string) => ActiveDocContext;
-export declare const getDocVersionSuggestions: (data: GlobalPluginData, pathname: string) => DocVersionSuggestions;
+export declare function getActiveVersion(data: GlobalPluginData, pathname: string): GlobalVersion | undefined;
+export declare function getActiveDocContext(data: GlobalPluginData, pathname: string): ActiveDocContext;
+export declare function getDocVersionSuggestions(data: GlobalPluginData, pathname: string): DocVersionSuggestions;

package/lib/client/docsClientUtils.js

@@ -12,8 +12,8 @@ const router_1 = require("@docusaurus/router");
 // get the data of the plugin that is currently "active"
 // ie the docs of that plugin are currently browsed
 // it is useful to support multiple docs plugin instances
-function getActivePlugin(allPluginDatas, pathname, options = {}) {
-    const activeEntry = Object.entries(allPluginDatas)
+function getActivePlugin(allPluginData, pathname, options = {}) {
+    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(([, pluginData]) => !!(0, router_1.matchPath)(pathname, {
@@ -25,7 +25,7 @@ function getActivePlugin(allPluginDatas, pathname, options = {}) {
         ? { pluginId: activeEntry[0], pluginData: activeEntry[1] }
         : undefined;
     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)
+        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(allPluginData)
             .map((plugin) => plugin.path)
             .join(', ')}`);
     }
@@ -34,9 +34,7 @@ function getActivePlugin(allPluginDatas, pathname, options = {}) {
 exports.getActivePlugin = getActivePlugin;
 const getLatestVersion = (data) => data.versions.find((version) => version.isLast);
 exports.getLatestVersion = getLatestVersion;
-// Note: return undefined on doc-unrelated pages,
-// because there's no version currently considered as active
-const getActiveVersion = (data, pathname) => {
+function getActiveVersion(data, pathname) {
     const lastVersion = (0, exports.getLatestVersion)(data);
     // Last version is a route like /docs/*,
     // we need to match it last or it would match /docs/version-1.0/* as well
@@ -49,11 +47,11 @@ const getActiveVersion = (data, pathname) => {
         exact: false,
         strict: false,
     }));
-};
+}
 exports.getActiveVersion = getActiveVersion;
-const getActiveDocContext = (data, pathname) => {
-    const activeVersion = (0, exports.getActiveVersion)(data, pathname);
-    const activeDoc = activeVersion === null || activeVersion === void 0 ? void 0 : activeVersion.docs.find((doc) => !!(0, router_1.matchPath)(pathname, {
+function getActiveDocContext(data, pathname) {
+    const activeVersion = getActiveVersion(data, pathname);
+    const activeDoc = activeVersion?.docs.find((doc) => !!(0, router_1.matchPath)(pathname, {
         path: doc.path,
         exact: true,
         strict: false,
@@ -77,12 +75,12 @@ const getActiveDocContext = (data, pathname) => {
         activeDoc,
         alternateDocVersions: alternateVersionDocs,
     };
-};
+}
 exports.getActiveDocContext = getActiveDocContext;
-const getDocVersionSuggestions = (data, pathname) => {
+function getDocVersionSuggestions(data, pathname) {
     const latestVersion = (0, exports.getLatestVersion)(data);
-    const activeDocContext = (0, exports.getActiveDocContext)(data, pathname);
-    const latestDocSuggestion = activeDocContext === null || activeDocContext === void 0 ? void 0 : activeDocContext.alternateDocVersions[latestVersion.name];
+    const activeDocContext = getActiveDocContext(data, pathname);
+    const latestDocSuggestion = activeDocContext?.alternateDocVersions[latestVersion.name];
     return { latestDocSuggestion, latestVersionSuggestion: latestVersion };
-};
+}
 exports.getDocVersionSuggestions = getDocVersionSuggestions;

package/lib/client/index.d.ts

@@ -4,16 +4,19 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { GlobalPluginData, GlobalVersion, ActivePlugin, ActiveDocContext, DocVersionSuggestions, GetActivePluginOptions } from '@docusaurus/plugin-content-docs/client';
-export declare const useAllDocsData: () => Record<string, GlobalPluginData>;
+import type { GlobalPluginData, GlobalVersion, ActivePlugin, ActiveDocContext, DocVersionSuggestions } from '@docusaurus/plugin-content-docs/client';
+import type { UseDataOptions } from '@docusaurus/types';
+export declare const useAllDocsData: () => {
+    [pluginId: string]: GlobalPluginData;
+};
 export declare const useDocsData: (pluginId: string | undefined) => GlobalPluginData;
-export declare const useActivePlugin: (options?: GetActivePluginOptions) => ActivePlugin | undefined;
-export declare const useActivePluginAndVersion: (options?: GetActivePluginOptions) => {
+export declare function useActivePlugin(options?: UseDataOptions): ActivePlugin | undefined;
+export declare function useActivePluginAndVersion(options?: UseDataOptions): {
     activePlugin: ActivePlugin;
     activeVersion: GlobalVersion | undefined;
 } | undefined;
-export declare const useVersions: (pluginId: string | undefined) => GlobalVersion[];
-export declare const useLatestVersion: (pluginId: string | undefined) => GlobalVersion;
-export declare const useActiveVersion: (pluginId: string | undefined) => GlobalVersion | undefined;
-export declare const useActiveDocContext: (pluginId: string | undefined) => ActiveDocContext;
-export declare const useDocVersionSuggestions: (pluginId: string | undefined) => DocVersionSuggestions;
+export declare function useVersions(pluginId: string | undefined): GlobalVersion[];
+export declare function useLatestVersion(pluginId: string | undefined): GlobalVersion;
+export declare function useActiveVersion(pluginId: string | undefined): GlobalVersion | undefined;
+export declare function useActiveDocContext(pluginId: string | undefined): ActiveDocContext;
+export declare function useDocVersionSuggestions(pluginId: string | undefined): DocVersionSuggestions;

package/lib/client/index.js

@@ -7,69 +7,66 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useDocVersionSuggestions = exports.useActiveDocContext = exports.useActiveVersion = exports.useLatestVersion = exports.useVersions = exports.useActivePluginAndVersion = exports.useActivePlugin = exports.useDocsData = exports.useAllDocsData = void 0;
-const tslib_1 = require("tslib");
 const router_1 = require("@docusaurus/router");
-const useGlobalData_1 = (0, tslib_1.__importStar)(require("@docusaurus/useGlobalData"));
+const useGlobalData_1 = require("@docusaurus/useGlobalData");
 const docsClientUtils_1 = require("./docsClientUtils");
 // Important to use a constant object to avoid React useEffect executions etc.
 // see https://github.com/facebook/docusaurus/issues/5089
 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
-const useAllDocsData = () => { var _a; return (_a = (0, useGlobalData_1.default)()['docusaurus-plugin-content-docs']) !== null && _a !== void 0 ? _a : 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
+const useAllDocsData = () => (0, useGlobalData_1.useAllPluginInstancesData)('docusaurus-plugin-content-docs') ??
+    StableEmptyObject;
 exports.useAllDocsData = useAllDocsData;
-const useDocsData = (pluginId) => (0, useGlobalData_1.usePluginData)('docusaurus-plugin-content-docs', pluginId);
+const useDocsData = (pluginId) => (0, useGlobalData_1.usePluginData)('docusaurus-plugin-content-docs', pluginId, {
+    failfast: true,
+});
 exports.useDocsData = useDocsData;
 // TODO this feature should be provided by docusaurus core
-const useActivePlugin = (options = {}) => {
+function useActivePlugin(options = {}) {
     const data = (0, exports.useAllDocsData)();
     const { pathname } = (0, router_1.useLocation)();
     return (0, docsClientUtils_1.getActivePlugin)(data, pathname, options);
-};
+}
 exports.useActivePlugin = useActivePlugin;
-const useActivePluginAndVersion = (options = {}) => {
-    const activePlugin = (0, exports.useActivePlugin)(options);
+function useActivePluginAndVersion(options = {}) {
+    const activePlugin = useActivePlugin(options);
     const { pathname } = (0, router_1.useLocation)();
-    if (activePlugin) {
-        const activeVersion = (0, docsClientUtils_1.getActiveVersion)(activePlugin.pluginData, pathname);
-        return {
-            activePlugin,
-            activeVersion,
-        };
+    if (!activePlugin) {
+        return undefined;
     }
-    return undefined;
-};
+    const activeVersion = (0, docsClientUtils_1.getActiveVersion)(activePlugin.pluginData, pathname);
+    return {
+        activePlugin,
+        activeVersion,
+    };
+}
 exports.useActivePluginAndVersion = useActivePluginAndVersion;
-// versions are returned ordered (most recent first)
-const useVersions = (pluginId) => {
+function useVersions(pluginId) {
     const data = (0, exports.useDocsData)(pluginId);
     return data.versions;
-};
+}
 exports.useVersions = useVersions;
-const useLatestVersion = (pluginId) => {
+function useLatestVersion(pluginId) {
     const data = (0, exports.useDocsData)(pluginId);
     return (0, docsClientUtils_1.getLatestVersion)(data);
-};
+}
 exports.useLatestVersion = useLatestVersion;
-// Note: return undefined on doc-unrelated pages,
-// because there's no version currently considered as active
-const useActiveVersion = (pluginId) => {
+function useActiveVersion(pluginId) {
     const data = (0, exports.useDocsData)(pluginId);
     const { pathname } = (0, router_1.useLocation)();
     return (0, docsClientUtils_1.getActiveVersion)(data, pathname);
-};
+}
 exports.useActiveVersion = useActiveVersion;
-const useActiveDocContext = (pluginId) => {
+function useActiveDocContext(pluginId) {
     const data = (0, exports.useDocsData)(pluginId);
     const { pathname } = (0, router_1.useLocation)();
     return (0, docsClientUtils_1.getActiveDocContext)(data, pathname);
-};
+}
 exports.useActiveDocContext = useActiveDocContext;
-// Useful to say "hey, you are not on the latest docs version, please switch"
-const useDocVersionSuggestions = (pluginId) => {
+function useDocVersionSuggestions(pluginId) {
     const data = (0, exports.useDocsData)(pluginId);
     const { pathname } = (0, router_1.useLocation)();
     return (0, docsClientUtils_1.getDocVersionSuggestions)(data, pathname);
-};
+}
 exports.useDocVersionSuggestions = useDocVersionSuggestions;

package/lib/constants.d.ts

@@ -4,7 +4,11 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+/** The name of the version that's actively worked on (e.g. `website/docs`) */
 export declare const CURRENT_VERSION_NAME = "current";
+/** All doc versions are stored here by version names */
 export declare const VERSIONED_DOCS_DIR = "versioned_docs";
+/** All doc versioned sidebars are stored here by version names */
 export declare const VERSIONED_SIDEBARS_DIR = "versioned_sidebars";
+/** The version names. Should 1-1 map to the content of versioned docs dir. */
 export declare const VERSIONS_JSON_FILE = "versions.json";

package/lib/constants.js

@@ -7,8 +7,11 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSIONS_JSON_FILE = exports.VERSIONED_SIDEBARS_DIR = exports.VERSIONED_DOCS_DIR = exports.CURRENT_VERSION_NAME = void 0;
-// The name of the version at the root of your site (website/docs)
+/** The name of the version that's actively worked on (e.g. `website/docs`) */
 exports.CURRENT_VERSION_NAME = 'current';
+/** All doc versions are stored here by version names */
 exports.VERSIONED_DOCS_DIR = 'versioned_docs';
+/** All doc versioned sidebars are stored here by version names */
 exports.VERSIONED_SIDEBARS_DIR = 'versioned_sidebars';
+/** The version names. Should 1-1 map to the content of versioned docs dir. */
 exports.VERSIONS_JSON_FILE = 'versions.json';

package/lib/docs.d.ts

@@ -5,17 +5,19 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { LoadContext } from '@docusaurus/types';
-import type { DocFile, DocMetadataBase, VersionMetadata, LoadedVersion } from './types';
+import type { DocFile } from './types';
 import type { SidebarsUtils } from './sidebars/utils';
-import type { MetadataOptions, PluginOptions, CategoryIndexMatcher, CategoryIndexMatcherParam } from '@docusaurus/plugin-content-docs';
+import type { MetadataOptions, PluginOptions, CategoryIndexMatcher, DocMetadataBase, VersionMetadata, LoadedVersion } from '@docusaurus/plugin-content-docs';
 declare type LastUpdateOptions = Pick<PluginOptions, 'showLastUpdateAuthor' | 'showLastUpdateTime'>;
 export declare function readDocFile(versionMetadata: Pick<VersionMetadata, 'contentPath' | 'contentPathLocalized'>, source: string, options: LastUpdateOptions): Promise<DocFile>;
 export declare function readVersionDocs(versionMetadata: VersionMetadata, options: Pick<PluginOptions, 'include' | 'exclude' | 'showLastUpdateAuthor' | 'showLastUpdateTime'>): Promise<DocFile[]>;
+export declare type DocEnv = 'production' | 'development';
 export declare function processDocMetadata(args: {
     docFile: DocFile;
     versionMetadata: VersionMetadata;
     context: LoadContext;
     options: MetadataOptions;
+    env: DocEnv;
 }): DocMetadataBase;
 export declare function addDocNavigation(docsBase: DocMetadataBase[], sidebarsUtils: SidebarsUtils, sidebarFilePath: string): LoadedVersion['docs'];
 /**
@@ -30,25 +32,16 @@ export declare function getMainDocId({ docs, sidebarsUtils, }: {
     sidebarsUtils: SidebarsUtils;
 }): string;
 export declare const isCategoryIndex: CategoryIndexMatcher;
-export declare function toCategoryIndexMatcherParam({ source, sourceDirName, }: Pick<DocMetadataBase, 'source' | 'sourceDirName'>): CategoryIndexMatcherParam;
 /**
  * `guides/sidebar/autogenerated.md` ->
  *   `'autogenerated', '.md', ['sidebar', 'guides']`
  */
-export declare 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;
-};
+export declare function toCategoryIndexMatcherParam({ source, sourceDirName, }: Pick<DocMetadataBase, 'source' | 'sourceDirName'>): Parameters<CategoryIndexMatcher>[0];
 export declare function getDocIds(doc: DocMetadataBase): [string, string];
 export declare function createDocsByIdIndex<Doc extends {
     id: string;
     unversionedId: string;
-}>(docs: Doc[]): Record<string, Doc>;
+}>(docs: Doc[]): {
+    [docId: string]: Doc;
+};
 export {};