@docusaurus/plugin-content-docs 2.0.0-beta.12faed89d → 2.0.0-beta.14

package/lib/slug.js

@@ -8,23 +8,33 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("@docusaurus/utils");
 const numberPrefix_1 = require("./numberPrefix");
-function getSlug({ baseID, frontmatterSlug, dirName, stripDirNumberPrefixes = true, numberPrefixParser = numberPrefix_1.DefaultNumberPrefixParser, }) {
-    const baseSlug = frontmatterSlug || baseID;
-    let slug;
-    if (baseSlug.startsWith('/')) {
-        slug = baseSlug;
-    }
-    else {
+const docs_1 = require("./docs");
+function getSlug({ baseID, frontmatterSlug, source, sourceDirName, stripDirNumberPrefixes = true, numberPrefixParser = numberPrefix_1.DefaultNumberPrefixParser, }) {
+    function getDirNameSlug() {
         const dirNameStripped = stripDirNumberPrefixes
-            ? numberPrefix_1.stripPathNumberPrefixes(dirName, numberPrefixParser)
-            : dirName;
-        const resolveDirname = dirName === '.'
+            ? (0, numberPrefix_1.stripPathNumberPrefixes)(sourceDirName, numberPrefixParser)
+            : sourceDirName;
+        const resolveDirname = sourceDirName === '.'
             ? '/'
-            : utils_1.addLeadingSlash(utils_1.addTrailingSlash(dirNameStripped));
-        slug = utils_1.resolvePathname(baseSlug, resolveDirname);
+            : (0, utils_1.addLeadingSlash)((0, utils_1.addTrailingSlash)(dirNameStripped));
+        return resolveDirname;
+    }
+    function computeSlug() {
+        if (frontmatterSlug === null || frontmatterSlug === void 0 ? void 0 : frontmatterSlug.startsWith('/')) {
+            return frontmatterSlug;
+        }
+        else {
+            const dirNameSlug = getDirNameSlug();
+            if (!frontmatterSlug && (0, docs_1.isConventionalDocIndex)({ source, sourceDirName })) {
+                return dirNameSlug;
+            }
+            const baseSlug = frontmatterSlug || baseID;
+            return (0, utils_1.resolvePathname)(baseSlug, getDirNameSlug());
+        }
     }
-    if (!utils_1.isValidPathname(slug)) {
-        throw new Error(`We couldn't compute a valid slug for document with id "${baseID}" in "${dirName}" directory.
+    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.
 The slug we computed looks invalid: ${slug}.
 Maybe your slug frontmatter is incorrect or you use weird chars in the file path?
 By using the slug frontmatter, you should be able to fix this error, by using the slug of your choice:
@@ -34,7 +44,9 @@ Example =>
 slug: /my/customDocPath
 ---
 `);
+        }
+        return slug;
     }
-    return slug;
+    return ensureValidSlug(computeSlug());
 }
 exports.default = getSlug;

package/{src/__tests__/__fixtures__/site-with-doc-label/docusaurus.config.js → lib/tags.d.ts}

@@ -4,11 +4,5 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-
-module.exports = {
-  title: 'My Site',
-  tagline: 'The tagline of my site',
-  url: 'https://your-docusaurus-test-site.com',
-  baseUrl: '/',
-  favicon: 'img/favicon.ico',
-};
+import type { VersionTags, DocMetadata } from './types';
+export declare function getVersionTags(docs: DocMetadata[]): VersionTags;

package/lib/tags.js

@@ -0,0 +1,20 @@
+"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.getVersionTags = void 0;
+const utils_1 = require("@docusaurus/utils");
+const lodash_1 = require("lodash");
+function getVersionTags(docs) {
+    const groups = (0, utils_1.groupTaggedItems)(docs, (doc) => doc.tags);
+    return (0, lodash_1.mapValues)(groups, (group) => ({
+        name: group.tag.label,
+        docIds: group.items.map((item) => item.id),
+        permalink: group.tag.permalink,
+    }));
+}
+exports.getVersionTags = getVersionTags;

package/lib/theme/hooks/useDocs.js

@@ -9,7 +9,7 @@ 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 = tslib_1.__importStar(require("@docusaurus/useGlobalData"));
+const useGlobalData_1 = (0, tslib_1.__importStar)(require("@docusaurus/useGlobalData"));
 const docsClientUtils_1 = require("../../client/docsClientUtils");
 // Important to use a constant object to avoid React useEffect executions etc...,
 // see https://github.com/facebook/docusaurus/issues/5089
@@ -18,21 +18,21 @@ const StableEmptyObject = {};
 // We need a fail-safe fallback when the docs plugin is not in use
 const useAllDocsData = () => { var _a; 
 // useAllPluginInstancesData('docusaurus-plugin-content-docs');
-return (_a = useGlobalData_1.default()['docusaurus-plugin-content-docs']) !== null && _a !== void 0 ? _a : StableEmptyObject; };
+return (_a = (0, useGlobalData_1.default)()['docusaurus-plugin-content-docs']) !== null && _a !== void 0 ? _a : StableEmptyObject; };
 exports.useAllDocsData = useAllDocsData;
-const useDocsData = (pluginId) => useGlobalData_1.usePluginData('docusaurus-plugin-content-docs', pluginId);
+const useDocsData = (pluginId) => (0, useGlobalData_1.usePluginData)('docusaurus-plugin-content-docs', pluginId);
 exports.useDocsData = useDocsData;
 const useActivePlugin = (options = {}) => {
-    const data = exports.useAllDocsData();
-    const { pathname } = router_1.useLocation();
-    return docsClientUtils_1.getActivePlugin(data, pathname, 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 = exports.useActivePlugin(options);
-    const { pathname } = router_1.useLocation();
+    const activePlugin = (0, exports.useActivePlugin)(options);
+    const { pathname } = (0, router_1.useLocation)();
     if (activePlugin) {
-        const activeVersion = docsClientUtils_1.getActiveVersion(activePlugin.pluginData, pathname);
+        const activeVersion = (0, docsClientUtils_1.getActiveVersion)(activePlugin.pluginData, pathname);
         return {
             activePlugin,
             activeVersion,
@@ -43,33 +43,33 @@ const useActivePluginAndVersion = (options = {}) => {
 exports.useActivePluginAndVersion = useActivePluginAndVersion;
 // versions are returned ordered (most recent first)
 const useVersions = (pluginId) => {
-    const data = exports.useDocsData(pluginId);
+    const data = (0, exports.useDocsData)(pluginId);
     return data.versions;
 };
 exports.useVersions = useVersions;
 const useLatestVersion = (pluginId) => {
-    const data = exports.useDocsData(pluginId);
-    return docsClientUtils_1.getLatestVersion(data);
+    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) => {
-    const data = exports.useDocsData(pluginId);
-    const { pathname } = router_1.useLocation();
-    return docsClientUtils_1.getActiveVersion(data, pathname);
+    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) => {
-    const data = exports.useDocsData(pluginId);
-    const { pathname } = router_1.useLocation();
-    return docsClientUtils_1.getActiveDocContext(data, pathname);
+    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) => {
-    const data = exports.useDocsData(pluginId);
-    const { pathname } = router_1.useLocation();
-    return docsClientUtils_1.getDocVersionSuggestions(data, pathname);
+    const data = (0, exports.useDocsData)(pluginId);
+    const { pathname } = (0, router_1.useLocation)();
+    return (0, docsClientUtils_1.getDocVersionSuggestions)(data, pathname);
 };
 exports.useDocVersionSuggestions = useDocVersionSuggestions;

package/lib/translations.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 { LoadedContent } from './types';
-import { TranslationFile, TranslationFiles } from '@docusaurus/types';
+import type { LoadedContent } from './types';
+import type { TranslationFile, TranslationFiles } from '@docusaurus/types';
 export declare function getLoadedContentTranslationFiles(loadedContent: LoadedContent): TranslationFiles;
 export declare function translateLoadedContent(loadedContent: LoadedContent, translationFiles: TranslationFile[]): LoadedContent;

package/lib/translations.js

@@ -8,8 +8,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.translateLoadedContent = exports.getLoadedContentTranslationFiles = void 0;
 const lodash_1 = require("lodash");
-const sidebars_1 = require("./sidebars");
-const utils_1 = require("@docusaurus/utils");
+const utils_1 = require("./sidebars/utils");
+const utils_2 = require("@docusaurus/utils");
 const constants_1 = require("./constants");
 function getVersionFileName(versionName) {
     if (versionName === constants_1.CURRENT_VERSION_NAME) {
@@ -32,7 +32,7 @@ function getNormalizedSidebarName({ versionName, sidebarName, }) {
     return rest.join('/');
 }
 /*
-// Do we need to translate doc metadatas?
+// Do we need to translate doc metadata?
 // It seems translating frontmatter labels is good enough
 function getDocTranslations(doc: DocMetadata): TranslationFileContent {
   return {
@@ -74,31 +74,75 @@ function translateDocs(
 }
  */
 function getSidebarTranslationFileContent(sidebar, sidebarName) {
-    const categories = sidebars_1.collectSidebarCategories(sidebar);
-    const categoryContent = lodash_1.chain(categories)
-        .keyBy((category) => `sidebar.${sidebarName}.category.${category.label}`)
-        .mapValues((category) => ({
-        message: category.label,
-        description: `The label for category ${category.label} in sidebar ${sidebarName}`,
-    }))
-        .value();
-    const links = sidebars_1.collectSidebarLinks(sidebar);
-    const linksContent = lodash_1.chain(links)
+    const categories = (0, utils_1.collectSidebarCategories)(sidebar);
+    const categoryContent = Object.fromEntries(categories.flatMap((category) => {
+        const entries = [];
+        entries.push([
+            `sidebar.${sidebarName}.category.${category.label}`,
+            {
+                message: category.label,
+                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}`,
+                        },
+                    ]);
+                }
+            }
+        }
+        return entries;
+    }));
+    const links = (0, utils_1.collectSidebarLinks)(sidebar);
+    const linksContent = (0, lodash_1.chain)(links)
         .keyBy((link) => `sidebar.${sidebarName}.link.${link.label}`)
         .mapValues((link) => ({
         message: link.label,
         description: `The label for link ${link.label} in sidebar ${sidebarName}, linking to ${link.href}`,
     }))
         .value();
-    return utils_1.mergeTranslations([categoryContent, linksContent]);
+    return (0, utils_2.mergeTranslations)([categoryContent, linksContent]);
 }
 function translateSidebar({ sidebar, sidebarName, sidebarsTranslations, }) {
-    return sidebars_1.transformSidebarItems(sidebar, (item) => {
+    function transformSidebarCategoryLink(category) {
+        var _a, _b, _c, _d;
+        if (!category.link) {
+            return undefined;
+        }
+        if (category.link.type === 'generated-index') {
+            const title = (_b = (_a = sidebarsTranslations[`sidebar.${sidebarName}.category.${category.label}.link.generated-index.title`]) === null || _a === void 0 ? void 0 : _a.message) !== null && _b !== void 0 ? _b : category.link.title;
+            const description = (_d = (_c = sidebarsTranslations[`sidebar.${sidebarName}.category.${category.label}.link.generated-index.description`]) === null || _c === void 0 ? void 0 : _c.message) !== null && _d !== void 0 ? _d : category.link.description;
+            return {
+                ...category.link,
+                title,
+                description,
+            };
+        }
+        return category.link;
+    }
+    return (0, utils_1.transformSidebarItems)(sidebar, (item) => {
         var _a, _b, _c, _d;
         if (item.type === 'category') {
+            const link = transformSidebarCategoryLink(item);
             return {
                 ...item,
                 label: (_b = (_a = sidebarsTranslations[`sidebar.${sidebarName}.category.${item.label}`]) === null || _a === void 0 ? void 0 : _a.message) !== null && _b !== void 0 ? _b : item.label,
+                ...(link && { link }),
             };
         }
         if (item.type === 'link') {
@@ -111,7 +155,7 @@ function translateSidebar({ sidebar, sidebarName, sidebarsTranslations, }) {
     });
 }
 function getSidebarsTranslations(version) {
-    return utils_1.mergeTranslations(Object.entries(version.sidebars).map(([sidebarName, sidebar]) => {
+    return (0, utils_2.mergeTranslations)(Object.entries(version.sidebars).map(([sidebarName, sidebar]) => {
         const normalizedSidebarName = getNormalizedSidebarName({
             sidebarName,
             versionName: version.versionName,
@@ -120,16 +164,14 @@ function getSidebarsTranslations(version) {
     }));
 }
 function translateSidebars(version, sidebarsTranslations) {
-    return lodash_1.mapValues(version.sidebars, (sidebar, sidebarName) => {
-        return translateSidebar({
-            sidebar,
-            sidebarName: getNormalizedSidebarName({
-                sidebarName,
-                versionName: version.versionName,
-            }),
-            sidebarsTranslations,
-        });
-    });
+    return (0, lodash_1.mapValues)(version.sidebars, (sidebar, sidebarName) => translateSidebar({
+        sidebar,
+        sidebarName: getNormalizedSidebarName({
+            sidebarName,
+            versionName: version.versionName,
+        }),
+        sidebarsTranslations,
+    }));
 }
 function getVersionTranslationFiles(version) {
     const versionTranslations = {
@@ -143,7 +185,7 @@ function getVersionTranslationFiles(version) {
     return [
         {
             path: getVersionFileName(version.versionName),
-            content: utils_1.mergeTranslations([
+            content: (0, utils_2.mergeTranslations)([
                 versionTranslations,
                 sidebarsTranslations,
                 // docsTranslations,
@@ -162,7 +204,7 @@ function translateVersion(version, translationFiles) {
     };
 }
 function getVersionsTranslationFiles(versions) {
-    return lodash_1.flatten(versions.map(getVersionTranslationFiles));
+    return versions.flatMap(getVersionTranslationFiles);
 }
 function translateVersions(versions, translationFiles) {
     return versions.map((version) => translateVersion(version, translationFiles));
@@ -172,7 +214,7 @@ function getLoadedContentTranslationFiles(loadedContent) {
 }
 exports.getLoadedContentTranslationFiles = getLoadedContentTranslationFiles;
 function translateLoadedContent(loadedContent, translationFiles) {
-    const translationFilesMap = lodash_1.keyBy(translationFiles, (f) => f.path);
+    const translationFilesMap = (0, lodash_1.keyBy)(translationFiles, (f) => f.path);
     return {
         loadedVersions: translateVersions(loadedContent.loadedVersions, translationFilesMap),
     };

package/lib/types.d.ts

@@ -5,7 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { RemarkAndRehypePluginOptions } from '@docusaurus/mdx-loader';
-import { BrokenMarkdownLink as IBrokenMarkdownLink, ContentPaths } from '@docusaurus/utils/lib/markdownLinks';
+import type { Tag, FrontMatterTag, Slugger } from '@docusaurus/utils';
+import type { BrokenMarkdownLink as IBrokenMarkdownLink, ContentPaths } from '@docusaurus/utils/lib/markdownLinks';
+import type { SidebarItemsGeneratorOption, Sidebars } from './sidebars/types';
 export declare type DocFile = {
     contentPath: string;
     filePath: string;
@@ -18,9 +20,12 @@ export declare type VersionMetadata = ContentPaths & {
     versionName: VersionName;
     versionLabel: string;
     versionPath: string;
+    tagsPath: string;
     versionEditUrl?: string | undefined;
     versionEditUrlLocalized?: string | undefined;
-    versionBanner: VersionBanner;
+    versionBanner: VersionBanner | null;
+    versionBadge: boolean;
+    versionClassName: string;
     isLast: boolean;
     sidebarFilePath: string | false | undefined;
     routePriority: number | undefined;
@@ -34,7 +39,6 @@ export declare type EditUrlFunction = (editUrlParams: {
 }) => string | undefined;
 export declare type MetadataOptions = {
     routeBasePath: string;
-    homePageId?: string;
     editUrl?: string | EditUrlFunction;
     editCurrentVersion: boolean;
     editLocalizedFiles: boolean;
@@ -46,80 +50,41 @@ export declare type PathOptions = {
     path: string;
     sidebarPath?: string | false | undefined;
 };
-export declare type VersionBanner = 'none' | 'unreleased' | 'unmaintained';
+export declare type VersionBanner = 'unreleased' | 'unmaintained';
 export declare type VersionOptions = {
     path?: string;
     label?: string;
-    banner?: VersionBanner;
+    banner?: 'none' | VersionBanner;
+    badge?: boolean;
+    className?: string;
 };
 export declare type VersionsOptions = {
     lastVersion?: string;
     versions: Record<string, VersionOptions>;
     onlyIncludeVersions?: string[];
 };
-export declare type PluginOptions = MetadataOptions & PathOptions & VersionsOptions & RemarkAndRehypePluginOptions & {
+export declare type SidebarOptions = {
+    sidebarCollapsible: boolean;
+    sidebarCollapsed: boolean;
+};
+export declare type NormalizeSidebarsParams = SidebarOptions & {
+    version: VersionMetadata;
+    categoryLabelSlugger: Slugger;
+};
+export declare type PluginOptions = MetadataOptions & PathOptions & VersionsOptions & RemarkAndRehypePluginOptions & SidebarOptions & {
     id: string;
     include: string[];
+    exclude: string[];
     docLayoutComponent: string;
     docItemComponent: string;
+    docTagDocListComponent: string;
+    docTagsListComponent: string;
+    docCategoryGeneratedIndexComponent: string;
     admonitions: Record<string, unknown>;
     disableVersioning: boolean;
     includeCurrentVersion: boolean;
     sidebarItemsGenerator: SidebarItemsGeneratorOption;
-};
-export declare type SidebarItemBase = {
-    customProps?: Record<string, unknown>;
-};
-export declare type SidebarItemDoc = SidebarItemBase & {
-    type: 'doc' | 'ref';
-    label?: string;
-    id: string;
-};
-export declare type SidebarItemLink = SidebarItemBase & {
-    type: 'link';
-    href: string;
-    label: string;
-};
-export declare type SidebarItemCategory = SidebarItemBase & {
-    type: 'category';
-    label: string;
-    items: SidebarItem[];
-    collapsed: boolean;
-};
-export declare type UnprocessedSidebarItemAutogenerated = {
-    type: 'autogenerated';
-    dirName: string;
-};
-export declare type UnprocessedSidebarItemCategory = SidebarItemBase & {
-    type: 'category';
-    label: string;
-    items: UnprocessedSidebarItem[];
-    collapsed: boolean;
-};
-export declare type UnprocessedSidebarItem = SidebarItemDoc | SidebarItemLink | UnprocessedSidebarItemCategory | UnprocessedSidebarItemAutogenerated;
-export declare type UnprocessedSidebar = UnprocessedSidebarItem[];
-export declare type UnprocessedSidebars = Record<string, UnprocessedSidebar>;
-export declare type SidebarItem = SidebarItemDoc | SidebarItemLink | SidebarItemCategory;
-export declare type Sidebar = SidebarItem[];
-export declare type SidebarItemType = SidebarItem['type'];
-export declare type Sidebars = Record<string, Sidebar>;
-export declare type SidebarItemsGeneratorDoc = Pick<DocMetadataBase, 'id' | 'frontMatter' | 'source' | 'sourceDirName' | 'sidebarPosition'>;
-export declare type SidebarItemsGeneratorVersion = Pick<VersionMetadata, 'versionName' | 'contentPath'>;
-export declare type SidebarItemsGeneratorArgs = {
-    item: UnprocessedSidebarItemAutogenerated;
-    version: SidebarItemsGeneratorVersion;
-    docs: SidebarItemsGeneratorDoc[];
-    numberPrefixParser: NumberPrefixParser;
-};
-export declare type SidebarItemsGenerator = (generatorArgs: SidebarItemsGeneratorArgs) => Promise<SidebarItem[]>;
-export declare type SidebarItemsGeneratorOptionArgs = {
-    defaultSidebarItemsGenerator: SidebarItemsGenerator;
-} & SidebarItemsGeneratorArgs;
-export declare type SidebarItemsGeneratorOption = (generatorArgs: SidebarItemsGeneratorOptionArgs) => Promise<SidebarItem[]>;
-export declare type OrderMetadata = {
-    previous?: string;
-    next?: string;
-    sidebar?: string;
+    tagsBasePath: string;
 };
 export declare type LastUpdateData = {
     lastUpdatedAt?: number;
@@ -129,6 +94,7 @@ export declare type LastUpdateData = {
 export declare type DocFrontMatter = {
     id?: string;
     title?: string;
+    tags?: FrontMatterTag[];
     hide_title?: boolean;
     hide_table_of_contents?: boolean;
     keywords?: string[];
@@ -137,15 +103,19 @@ export declare type DocFrontMatter = {
     slug?: string;
     sidebar_label?: string;
     sidebar_position?: number;
+    sidebar_class_name?: string;
     pagination_label?: string;
     custom_edit_url?: string | null;
     parse_number_prefixes?: boolean;
+    toc_min_heading_level?: number;
+    toc_max_heading_level?: number;
+    pagination_next?: string | null;
+    pagination_prev?: string | null;
 };
 export declare type DocMetadataBase = LastUpdateData & {
-    version: VersionName;
-    unversionedId: string;
     id: string;
-    isDocsHomePage: boolean;
+    unversionedId: string;
+    version: VersionName;
     title: string;
     description: string;
     source: string;
@@ -154,6 +124,7 @@ export declare type DocMetadataBase = LastUpdateData & {
     permalink: string;
     sidebarPosition?: number;
     editUrl?: string | null;
+    tags: Tag[];
     frontMatter: DocFrontMatter & Record<string, unknown>;
 };
 export declare type DocNavLink = {
@@ -165,14 +136,32 @@ export declare type DocMetadata = DocMetadataBase & {
     previous?: DocNavLink;
     next?: DocNavLink;
 };
+export declare type CategoryGeneratedIndexMetadata = {
+    title: string;
+    description?: string;
+    slug: string;
+    permalink: string;
+    sidebar: string;
+    previous?: DocNavLink;
+    next?: DocNavLink;
+};
 export declare type SourceToPermalink = {
     [source: string]: string;
 };
+export declare type VersionTag = {
+    name: string;
+    docIds: string[];
+    permalink: string;
+};
+export declare type VersionTags = {
+    [key: string]: VersionTag;
+};
 export declare type LoadedVersion = VersionMetadata & {
     versionPath: string;
     mainDocId: string;
     docs: DocMetadata[];
     sidebars: Sidebars;
+    categoryGeneratedIndices: CategoryGeneratedIndexMetadata[];
 };
 export declare type LoadedContent = {
     loadedVersions: LoadedVersion[];

package/lib/versions.d.ts

@@ -4,13 +4,13 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { PluginOptions, VersionMetadata } from './types';
-import { LoadContext } from '@docusaurus/types';
+import type { PluginOptions, VersionMetadata } from './types';
+import type { LoadContext } from '@docusaurus/types';
 export declare function getVersionedDocsDirPath(siteDir: string, pluginId: string): string;
 export declare function getVersionedSidebarsDirPath(siteDir: string, pluginId: string): string;
 export declare function getVersionsFilePath(siteDir: string, pluginId: string): string;
 export declare function readVersionsMetadata({ context, options, }: {
     context: Pick<LoadContext, 'siteDir' | 'baseUrl' | 'i18n'>;
-    options: Pick<PluginOptions, 'id' | 'path' | 'sidebarPath' | 'routeBasePath' | 'includeCurrentVersion' | 'disableVersioning' | 'lastVersion' | 'versions' | 'onlyIncludeVersions' | 'editUrl' | 'editCurrentVersion'>;
+    options: Pick<PluginOptions, 'id' | 'path' | 'sidebarPath' | 'routeBasePath' | 'tagsBasePath' | 'includeCurrentVersion' | 'disableVersioning' | 'lastVersion' | 'versions' | 'onlyIncludeVersions' | 'editUrl' | 'editCurrentVersion'>;
 }): VersionMetadata[];
 export declare function getDocsDirPaths(versionMetadata: Pick<VersionMetadata, 'contentPath' | 'contentPathLocalized'>): [string, string];