@docusaurus/plugin-content-docs 2.0.0-beta.8e9b829d9 → 2.0.0-beta.9

package/lib/sidebars/utils.js

@@ -0,0 +1,101 @@
+"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.createSidebarsUtils = exports.collectSidebarsDocIds = exports.collectSidebarLinks = exports.collectSidebarCategories = exports.collectSidebarDocItems = exports.transformSidebarItems = void 0;
+const lodash_1 = require("lodash");
+const utils_1 = require("@docusaurus/utils");
+function transformSidebarItems(sidebar, updateFn) {
+    function transformRecursive(item) {
+        if (item.type === 'category') {
+            return updateFn({
+                ...item,
+                items: item.items.map(transformRecursive),
+            });
+        }
+        return updateFn(item);
+    }
+    return sidebar.map(transformRecursive);
+}
+exports.transformSidebarItems = transformSidebarItems;
+function collectSidebarItemsOfType(type, sidebar) {
+    function collectRecursive(item) {
+        const currentItemsCollected = item.type === type ? [item] : [];
+        const childItemsCollected = item.type === 'category' ? item.items.flatMap(collectRecursive) : [];
+        return [...currentItemsCollected, ...childItemsCollected];
+    }
+    return sidebar.flatMap(collectRecursive);
+}
+function collectSidebarDocItems(sidebar) {
+    return collectSidebarItemsOfType('doc', sidebar);
+}
+exports.collectSidebarDocItems = collectSidebarDocItems;
+function collectSidebarCategories(sidebar) {
+    return collectSidebarItemsOfType('category', sidebar);
+}
+exports.collectSidebarCategories = collectSidebarCategories;
+function collectSidebarLinks(sidebar) {
+    return collectSidebarItemsOfType('link', sidebar);
+}
+exports.collectSidebarLinks = collectSidebarLinks;
+function collectSidebarsDocIds(sidebars) {
+    return (0, lodash_1.mapValues)(sidebars, (sidebar) => {
+        return collectSidebarDocItems(sidebar).map((docItem) => docItem.id);
+    });
+}
+exports.collectSidebarsDocIds = collectSidebarsDocIds;
+function createSidebarsUtils(sidebars) {
+    const sidebarNameToDocIds = collectSidebarsDocIds(sidebars);
+    // Reverse mapping
+    const docIdToSidebarName = Object.fromEntries(Object.entries(sidebarNameToDocIds).flatMap(([sidebarName, docIds]) => docIds.map((docId) => [docId, sidebarName])));
+    function getFirstDocIdOfFirstSidebar() {
+        var _a;
+        return (_a = Object.values(sidebarNameToDocIds)[0]) === null || _a === void 0 ? void 0 : _a[0];
+    }
+    function getSidebarNameByDocId(docId) {
+        return docIdToSidebarName[docId];
+    }
+    function getDocNavigation(docId) {
+        const sidebarName = getSidebarNameByDocId(docId);
+        if (sidebarName) {
+            const docIds = sidebarNameToDocIds[sidebarName];
+            const currentIndex = docIds.indexOf(docId);
+            const { previous, next } = (0, utils_1.getElementsAround)(docIds, currentIndex);
+            return {
+                sidebarName,
+                previousId: previous,
+                nextId: next,
+            };
+        }
+        else {
+            return {
+                sidebarName: undefined,
+                previousId: undefined,
+                nextId: undefined,
+            };
+        }
+    }
+    function checkSidebarsDocIds(validDocIds, sidebarFilePath) {
+        const allSidebarDocIds = Object.values(sidebarNameToDocIds).flat();
+        const invalidSidebarDocIds = (0, lodash_1.difference)(allSidebarDocIds, validDocIds);
+        if (invalidSidebarDocIds.length > 0) {
+            throw new Error(`Invalid sidebar file at "${(0, utils_1.toMessageRelativeFilePath)(sidebarFilePath)}".
+These sidebar document ids do not exist:
+- ${invalidSidebarDocIds.sort().join('\n- ')}
+
+Available document ids are:
+- ${validDocIds.sort().join('\n- ')}`);
+        }
+    }
+    return {
+        getFirstDocIdOfFirstSidebar,
+        getSidebarNameByDocId,
+        getDocNavigation,
+        checkSidebarsDocIds,
+    };
+}
+exports.createSidebarsUtils = createSidebarsUtils;

package/lib/sidebars/validation.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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 { SidebarsConfig } from './types';
+export declare function validateSidebars(sidebars: unknown): asserts sidebars is SidebarsConfig;

package/lib/sidebars/validation.js

@@ -0,0 +1,102 @@
+"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.validateSidebars = void 0;
+const utils_validation_1 = require("@docusaurus/utils-validation");
+const types_1 = require("./types");
+const sidebarItemBaseSchema = utils_validation_1.Joi.object({
+    className: utils_validation_1.Joi.string(),
+    customProps: utils_validation_1.Joi.object().unknown(),
+});
+const sidebarItemAutogeneratedSchema = sidebarItemBaseSchema.append({
+    type: 'autogenerated',
+    dirName: utils_validation_1.Joi.string()
+        .required()
+        .pattern(/^[^/](.*[^/])?$/)
+        .message('"dirName" must be a dir path relative to the docs folder root, and should not start or end with slash'),
+});
+const sidebarItemDocSchema = sidebarItemBaseSchema.append({
+    type: utils_validation_1.Joi.string().valid('doc', 'ref').required(),
+    id: utils_validation_1.Joi.string().required(),
+    label: utils_validation_1.Joi.string(),
+});
+const sidebarItemLinkSchema = sidebarItemBaseSchema.append({
+    type: 'link',
+    href: utils_validation_1.URISchema.required(),
+    label: utils_validation_1.Joi.string()
+        .required()
+        .messages({ 'any.unknown': '"label" must be a string' }),
+});
+const sidebarItemCategorySchema = sidebarItemBaseSchema.append({
+    type: 'category',
+    label: utils_validation_1.Joi.string()
+        .required()
+        .messages({ 'any.unknown': '"label" must be a string' }),
+    // TODO: Joi doesn't allow mutual recursion. See https://github.com/sideway/joi/issues/2611
+    items: utils_validation_1.Joi.array()
+        .required()
+        .messages({ 'any.unknown': '"items" must be an array' }),
+    collapsed: utils_validation_1.Joi.boolean().messages({
+        'any.unknown': '"collapsed" must be a boolean',
+    }),
+    collapsible: utils_validation_1.Joi.boolean().messages({
+        'any.unknown': '"collapsible" must be a boolean',
+    }),
+});
+const sidebarItemSchema = utils_validation_1.Joi.object()
+    .when('.type', {
+    switch: [
+        { is: 'link', then: sidebarItemLinkSchema },
+        {
+            is: utils_validation_1.Joi.string().valid('doc', 'ref').required(),
+            then: sidebarItemDocSchema,
+        },
+        { is: 'autogenerated', then: sidebarItemAutogeneratedSchema },
+        { is: 'category', then: sidebarItemCategorySchema },
+        {
+            is: 'subcategory',
+            then: utils_validation_1.Joi.forbidden().messages({
+                'any.unknown': 'Docusaurus v2: "subcategory" has been renamed as "category".',
+            }),
+        },
+        {
+            is: utils_validation_1.Joi.string().required(),
+            then: utils_validation_1.Joi.forbidden().messages({
+                'any.unknown': 'Unknown sidebar item type "{.type}".',
+            }),
+        },
+    ],
+})
+    .id('sidebarItemSchema');
+function validateSidebarItem(item) {
+    if (typeof item === 'string') {
+        return;
+    }
+    // TODO: remove once with proper Joi support
+    // Because we can't use Joi to validate nested items (see above), we do it manually
+    if ((0, types_1.isCategoriesShorthand)(item)) {
+        Object.values(item).forEach((category) => category.forEach(validateSidebarItem));
+    }
+    else {
+        utils_validation_1.Joi.assert(item, sidebarItemSchema);
+        if (item.type === 'category') {
+            item.items.forEach(validateSidebarItem);
+        }
+    }
+}
+function validateSidebars(sidebars) {
+    Object.values(sidebars).forEach((sidebar) => {
+        if (Array.isArray(sidebar)) {
+            sidebar.forEach(validateSidebarItem);
+        }
+        else {
+            validateSidebarItem(sidebar);
+        }
+    });
+}
+exports.validateSidebars = validateSidebars;

package/lib/slug.js

@@ -16,14 +16,14 @@ function getSlug({ baseID, frontmatterSlug, dirName, stripDirNumberPrefixes = tr
     }
     else {
         const dirNameStripped = stripDirNumberPrefixes
-            ? numberPrefix_1.stripPathNumberPrefixes(dirName, numberPrefixParser)
+            ? (0, numberPrefix_1.stripPathNumberPrefixes)(dirName, numberPrefixParser)
             : dirName;
         const resolveDirname = dirName === '.'
             ? '/'
-            : utils_1.addLeadingSlash(utils_1.addTrailingSlash(dirNameStripped));
-        slug = utils_1.resolvePathname(baseSlug, resolveDirname);
+            : (0, utils_1.addLeadingSlash)((0, utils_1.addTrailingSlash)(dirNameStripped));
+        slug = (0, utils_1.resolvePathname)(baseSlug, resolveDirname);
     }
-    if (!utils_1.isValidPathname(slug)) {
+    if (!(0, utils_1.isValidPathname)(slug)) {
         throw new Error(`We couldn't compute a valid slug for document with id "${baseID}" in "${dirName}" directory.
 The slug we computed looks invalid: ${slug}.
 Maybe your slug frontmatter is incorrect or you use weird chars in the file path?

package/lib/tags.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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 { VersionTags, DocMetadata } from './types';
+export declare function getVersionTags(docs: DocMetadata[]): VersionTags;

package/lib/tags.js

@@ -0,0 +1,22 @@
+"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) => {
+        return {
+            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 type { LoadedContent } from './types';
 import { 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) {
@@ -74,26 +74,26 @@ function translateDocs(
 }
  */
 function getSidebarTranslationFileContent(sidebar, sidebarName) {
-    const categories = sidebars_1.collectSidebarCategories(sidebar);
-    const categoryContent = lodash_1.chain(categories)
+    const categories = (0, utils_1.collectSidebarCategories)(sidebar);
+    const categoryContent = (0, 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 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) => {
+    return (0, utils_1.transformSidebarItems)(sidebar, (item) => {
         var _a, _b, _c, _d;
         if (item.type === 'category') {
             return {
@@ -111,7 +111,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,7 +120,7 @@ function getSidebarsTranslations(version) {
     }));
 }
 function translateSidebars(version, sidebarsTranslations) {
-    return lodash_1.mapValues(version.sidebars, (sidebar, sidebarName) => {
+    return (0, lodash_1.mapValues)(version.sidebars, (sidebar, sidebarName) => {
         return translateSidebar({
             sidebar,
             sidebarName: getNormalizedSidebarName({
@@ -143,7 +143,7 @@ function getVersionTranslationFiles(version) {
     return [
         {
             path: getVersionFileName(version.versionName),
-            content: utils_1.mergeTranslations([
+            content: (0, utils_2.mergeTranslations)([
                 versionTranslations,
                 sidebarsTranslations,
                 // docsTranslations,
@@ -162,7 +162,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 +172,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 } 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;
@@ -46,11 +51,13 @@ 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;
@@ -67,67 +74,13 @@ export declare type PluginOptions = MetadataOptions & PathOptions & VersionsOpti
     exclude: string[];
     docLayoutComponent: string;
     docItemComponent: string;
+    docTagDocListComponent: string;
+    docTagsListComponent: 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;
-    collapsible: boolean;
-};
-export declare type UnprocessedSidebarItemAutogenerated = {
-    type: 'autogenerated';
-    dirName: string;
-};
-export declare type UnprocessedSidebarItemCategory = SidebarItemBase & {
-    type: 'category';
-    label: string;
-    items: UnprocessedSidebarItem[];
-    collapsed: boolean;
-    collapsible: 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;
-    options: SidebarOptions;
-};
-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;
@@ -137,6 +90,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[];
@@ -145,9 +99,14 @@ 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;
@@ -162,6 +121,7 @@ export declare type DocMetadataBase = LastUpdateData & {
     permalink: string;
     sidebarPosition?: number;
     editUrl?: string | null;
+    tags: Tag[];
     frontMatter: DocFrontMatter & Record<string, unknown>;
 };
 export declare type DocNavLink = {
@@ -176,6 +136,14 @@ export declare type DocMetadata = DocMetadataBase & {
 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;

package/lib/versions.d.ts

@@ -11,6 +11,6 @@ export declare function getVersionedSidebarsDirPath(siteDir: string, pluginId: s
 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];