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

package/src/types.ts

@@ -5,14 +5,15 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-// eslint-disable-next-line spaced-comment
 /// <reference types="@docusaurus/module-type-aliases" />
 
 import type {RemarkAndRehypePluginOptions} from '@docusaurus/mdx-loader';
-import {
+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 type DocFile = {
   contentPath: string; // /!\ may be localized
@@ -28,9 +29,12 @@ export type VersionMetadata = ContentPaths & {
   versionName: VersionName; // 1.0.0
   versionLabel: string; // Version 1.0.0
   versionPath: string; // /baseUrl/docs/1.0.0
+  tagsPath: string;
   versionEditUrl?: string | undefined;
   versionEditUrlLocalized?: string | undefined;
-  versionBanner: VersionBanner;
+  versionBanner: VersionBanner | null;
+  versionBadge: boolean;
+  versionClassName: string;
   isLast: boolean;
   sidebarFilePath: string | false | undefined; // versioned_sidebars/1.0.0.json
   routePriority: number | undefined; // -1 for the latest docs
@@ -46,7 +50,6 @@ export type EditUrlFunction = (editUrlParams: {
 
 export type MetadataOptions = {
   routeBasePath: string;
-  homePageId?: string;
   editUrl?: string | EditUrlFunction;
   editCurrentVersion: boolean;
   editLocalizedFiles: boolean;
@@ -61,12 +64,14 @@ export type PathOptions = {
 };
 
 // TODO support custom version banner? {type: "error", content: "html content"}
-export type VersionBanner = 'none' | 'unreleased' | 'unmaintained';
+export type VersionBanner = 'unreleased' | 'unmaintained';
 
 export type VersionOptions = {
   path?: string;
   label?: string;
-  banner?: VersionBanner;
+  banner?: 'none' | VersionBanner;
+  badge?: boolean;
+  className?: string;
 };
 
 export type VersionsOptions = {
@@ -75,110 +80,36 @@ export type VersionsOptions = {
   onlyIncludeVersions?: string[];
 };
 
+export type SidebarOptions = {
+  sidebarCollapsible: boolean;
+  sidebarCollapsed: boolean;
+};
+
+export type NormalizeSidebarsParams = SidebarOptions & {
+  version: VersionMetadata;
+  categoryLabelSlugger: Slugger;
+};
+
 export type PluginOptions = MetadataOptions &
   PathOptions &
   VersionsOptions &
-  RemarkAndRehypePluginOptions & {
+  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;
+    tagsBasePath: string;
   };
 
-export type SidebarItemBase = {
-  customProps?: Record<string, unknown>;
-};
-
-export type SidebarItemDoc = SidebarItemBase & {
-  type: 'doc' | 'ref';
-  label?: string;
-  id: string;
-};
-
-export type SidebarItemLink = SidebarItemBase & {
-  type: 'link';
-  href: string;
-  label: string;
-};
-
-export type SidebarItemCategory = SidebarItemBase & {
-  type: 'category';
-  label: string;
-  items: SidebarItem[];
-  collapsed: boolean;
-};
-
-export type UnprocessedSidebarItemAutogenerated = {
-  type: 'autogenerated';
-  dirName: string;
-};
-
-export type UnprocessedSidebarItemCategory = SidebarItemBase & {
-  type: 'category';
-  label: string;
-  items: UnprocessedSidebarItem[];
-  collapsed: boolean;
-};
-
-export type UnprocessedSidebarItem =
-  | SidebarItemDoc
-  | SidebarItemLink
-  | UnprocessedSidebarItemCategory
-  | UnprocessedSidebarItemAutogenerated;
-
-export type UnprocessedSidebar = UnprocessedSidebarItem[];
-export type UnprocessedSidebars = Record<string, UnprocessedSidebar>;
-
-export type SidebarItem =
-  | SidebarItemDoc
-  | SidebarItemLink
-  | SidebarItemCategory;
-
-export type Sidebar = SidebarItem[];
-export type SidebarItemType = SidebarItem['type'];
-export type Sidebars = Record<string, Sidebar>;
-
-// Reduce API surface for options.sidebarItemsGenerator
-// The user-provided generator fn should receive only a subset of metadatas
-// A change to any of these metadatas can be considered as a breaking change
-export type SidebarItemsGeneratorDoc = Pick<
-  DocMetadataBase,
-  'id' | 'frontMatter' | 'source' | 'sourceDirName' | 'sidebarPosition'
->;
-export type SidebarItemsGeneratorVersion = Pick<
-  VersionMetadata,
-  'versionName' | 'contentPath'
->;
-
-export type SidebarItemsGeneratorArgs = {
-  item: UnprocessedSidebarItemAutogenerated;
-  version: SidebarItemsGeneratorVersion;
-  docs: SidebarItemsGeneratorDoc[];
-  numberPrefixParser: NumberPrefixParser;
-};
-export type SidebarItemsGenerator = (
-  generatorArgs: SidebarItemsGeneratorArgs,
-) => Promise<SidebarItem[]>;
-
-// Also inject the default generator to conveniently wrap/enhance/sort the default sidebar gen logic
-// see https://github.com/facebook/docusaurus/issues/4640#issuecomment-822292320
-export type SidebarItemsGeneratorOptionArgs = {
-  defaultSidebarItemsGenerator: SidebarItemsGenerator;
-} & SidebarItemsGeneratorArgs;
-export type SidebarItemsGeneratorOption = (
-  generatorArgs: SidebarItemsGeneratorOptionArgs,
-) => Promise<SidebarItem[]>;
-
-export type OrderMetadata = {
-  previous?: string;
-  next?: string;
-  sidebar?: string;
-};
-
 export type LastUpdateData = {
   lastUpdatedAt?: number;
   formattedLastUpdatedAt?: string;
@@ -187,9 +118,9 @@ export type LastUpdateData = {
 
 export type DocFrontMatter = {
   // Front matter uses snake case
-  /* eslint-disable camelcase */
   id?: string;
   title?: string;
+  tags?: FrontMatterTag[];
   hide_title?: boolean;
   hide_table_of_contents?: boolean;
   keywords?: string[];
@@ -198,25 +129,29 @@ export 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;
-  /* eslint-enable camelcase */
+  toc_min_heading_level?: number;
+  toc_max_heading_level?: number;
+  pagination_next?: string | null;
+  pagination_prev?: string | null;
 };
 
 export type DocMetadataBase = LastUpdateData & {
+  id: string; // TODO legacy versioned id => try to remove
+  unversionedId: string; // TODO new unversioned id => try to rename to "id"
   version: VersionName;
-  unversionedId: string;
-  id: string;
-  isDocsHomePage: boolean;
   title: string;
   description: string;
-  source: string;
-  sourceDirName: string; // relative to the docs folder (can be ".")
+  source: string; // @site aliased source => "@site/docs/folder/subFolder/subSubFolder/myDoc.md"
+  sourceDirName: string; // relative to the versioned docs folder (can be ".") => "folder/subFolder/subSubFolder"
   slug: string;
   permalink: string;
   sidebarPosition?: number;
   editUrl?: string | null;
+  tags: Tag[];
   frontMatter: DocFrontMatter & Record<string, unknown>;
 };
 
@@ -231,14 +166,35 @@ export type DocMetadata = DocMetadataBase & {
   next?: DocNavLink;
 };
 
+export type CategoryGeneratedIndexMetadata = {
+  title: string;
+  description?: string;
+  slug: string;
+  permalink: string;
+  sidebar: string;
+  previous?: DocNavLink;
+  next?: DocNavLink;
+};
+
 export type SourceToPermalink = {
   [source: string]: string;
 };
+
+export type VersionTag = {
+  name: string; // normalized name/label of the tag
+  docIds: string[]; // all doc ids having this tag
+  permalink: string; // pathname of the tag
+};
+export type VersionTags = {
+  [key: string]: VersionTag;
+};
+
 export type LoadedVersion = VersionMetadata & {
   versionPath: string;
   mainDocId: string;
   docs: DocMetadata[];
   sidebars: Sidebars;
+  categoryGeneratedIndices: CategoryGeneratedIndexMetadata[];
 };
 
 export type LoadedContent = {
@@ -274,6 +230,7 @@ export type DocsMarkdownOption = {
   onBrokenMarkdownLink: (brokenMarkdownLink: BrokenMarkdownLink) => void;
 };
 
-export type NumberPrefixParser = (
-  filename: string,
-) => {filename: string; numberPrefix?: number};
+export type NumberPrefixParser = (filename: string) => {
+  filename: string;
+  numberPrefix?: number;
+};

package/src/versions.ts

@@ -7,7 +7,7 @@
 
 import path from 'path';
 import fs from 'fs-extra';
-import {
+import type {
   PluginOptions,
   VersionBanner,
   VersionMetadata,
@@ -21,9 +21,13 @@ import {
   CURRENT_VERSION_NAME,
 } from './constants';
 
-import {DEFAULT_PLUGIN_ID} from '@docusaurus/core/lib/constants';
-import {LoadContext} from '@docusaurus/types';
-import {getPluginI18nPath, normalizeUrl, posixPath} from '@docusaurus/utils';
+import type {LoadContext} from '@docusaurus/types';
+import {
+  getPluginI18nPath,
+  normalizeUrl,
+  posixPath,
+  DEFAULT_PLUGIN_ID,
+} from '@docusaurus/utils';
 import {difference} from 'lodash';
 import {resolveSidebarPathOption} from './sidebars';
 
@@ -264,10 +268,10 @@ function getDefaultVersionBanner({
   versionName: string;
   versionNames: string[];
   lastVersionName: string;
-}): VersionBanner {
+}): VersionBanner | null {
   // Current version: good, no banner
   if (versionName === lastVersionName) {
-    return 'none';
+    return null;
   }
   // Upcoming versions: unreleased banner
   else if (
@@ -291,17 +295,45 @@ function getVersionBanner({
   versionNames: string[];
   lastVersionName: string;
   options: Pick<PluginOptions, 'versions'>;
-}): VersionBanner {
-  const versionOptionBanner = options.versions[versionName]?.banner;
+}): VersionBanner | null {
+  const versionBannerOption = options.versions[versionName]?.banner;
+  if (versionBannerOption) {
+    return versionBannerOption === 'none' ? null : versionBannerOption;
+  }
+  return getDefaultVersionBanner({
+    versionName,
+    versionNames,
+    lastVersionName,
+  });
+}
 
-  return (
-    versionOptionBanner ??
-    getDefaultVersionBanner({
-      versionName,
-      versionNames,
-      lastVersionName,
-    })
-  );
+function getVersionBadge({
+  versionName,
+  versionNames,
+  options,
+}: {
+  versionName: string;
+  versionNames: string[];
+  options: Pick<PluginOptions, 'versions'>;
+}): boolean {
+  const versionBadgeOption = options.versions[versionName]?.badge;
+  // If site is not versioned or only one version is included
+  // we don't show the version badge by default
+  // See https://github.com/facebook/docusaurus/issues/3362
+  const versionBadgeDefault = versionNames.length !== 1;
+  return versionBadgeOption ?? versionBadgeDefault;
+}
+
+function getVersionClassName({
+  versionName,
+  options,
+}: {
+  versionName: string;
+  options: Pick<PluginOptions, 'versions'>;
+}): string {
+  const versionClassNameOption = options.versions[versionName]?.className;
+  const versionClassNameDefault = `docs-version-${versionName}`;
+  return versionClassNameOption ?? versionClassNameDefault;
 }
 
 function createVersionMetadata({
@@ -321,20 +353,14 @@ function createVersionMetadata({
     | 'path'
     | 'sidebarPath'
     | 'routeBasePath'
+    | 'tagsBasePath'
     | 'versions'
     | 'editUrl'
     | 'editCurrentVersion'
   >;
 }): VersionMetadata {
-  const {
-    sidebarFilePath,
-    contentPath,
-    contentPathLocalized,
-  } = getVersionMetadataPaths({
-    versionName,
-    context,
-    options,
-  });
+  const {sidebarFilePath, contentPath, contentPathLocalized} =
+    getVersionMetadataPaths({versionName, context, options});
 
   const isLast = versionName === lastVersionName;
 
@@ -370,10 +396,15 @@ function createVersionMetadata({
   // Because /docs/:route` should always be after `/docs/versionName/:route`.
   const routePriority = versionPathPart === '' ? -1 : undefined;
 
+  // the path that will be used to refer the docs tags
+  // example below will be using /docs/tags
+  const tagsPath = normalizeUrl([versionPath, options.tagsBasePath]);
+
   return {
     versionName,
     versionLabel,
     versionPath,
+    tagsPath,
     versionEditUrl: versionEditUrls?.versionEditUrl,
     versionEditUrlLocalized: versionEditUrls?.versionEditUrlLocalized,
     versionBanner: getVersionBanner({
@@ -382,6 +413,8 @@ function createVersionMetadata({
       lastVersionName,
       options,
     }),
+    versionBadge: getVersionBadge({versionName, versionNames, options}),
+    versionClassName: getVersionClassName({versionName, options}),
     isLast,
     routePriority,
     sidebarFilePath,
@@ -526,6 +559,7 @@ export function readVersionsMetadata({
     | 'path'
     | 'sidebarPath'
     | 'routeBasePath'
+    | 'tagsBasePath'
     | 'includeCurrentVersion'
     | 'disableVersioning'
     | 'lastVersion'

package/lib/sidebarItemsGenerator.js

@@ -1,211 +0,0 @@
-"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.DefaultSidebarItemsGenerator = exports.CategoryMetadataFilenamePattern = exports.CategoryMetadataFilenameBase = void 0;
-const tslib_1 = require("tslib");
-const lodash_1 = require("lodash");
-const utils_1 = require("@docusaurus/utils");
-const utils_validation_1 = require("@docusaurus/utils-validation");
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
-const path_1 = tslib_1.__importDefault(require("path"));
-const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
-const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
-const sidebars_1 = require("./sidebars");
-const BreadcrumbSeparator = '/';
-exports.CategoryMetadataFilenameBase = '_category_';
-exports.CategoryMetadataFilenamePattern = '_category_.{json,yml,yaml}';
-const CategoryMetadatasFileSchema = utils_validation_1.Joi.object({
-    label: utils_validation_1.Joi.string(),
-    position: utils_validation_1.Joi.number(),
-    collapsed: utils_validation_1.Joi.boolean(),
-});
-// TODO I now believe we should read all the category metadata files ahead of time: we may need this metadata to customize docs metadata
-// Example use-case being able to disable number prefix parsing at the folder level, or customize the default route path segment for an intermediate directory...
-// TODO later if there is `CategoryFolder/index.md`, we may want to read the metadata as yaml on it
-// see https://github.com/facebook/docusaurus/issues/3464#issuecomment-818670449
-async function readCategoryMetadatasFile(categoryDirPath) {
-    var _a, _b;
-    function validateCategoryMetadataFile(content) {
-        return utils_validation_1.Joi.attempt(content, CategoryMetadatasFileSchema);
-    }
-    async function tryReadFile(fileNameWithExtension, parse) {
-        // Simpler to use only posix paths for mocking file metadatas in tests
-        const filePath = utils_1.posixPath(path_1.default.join(categoryDirPath, fileNameWithExtension));
-        if (await fs_extra_1.default.pathExists(filePath)) {
-            const contentString = await fs_extra_1.default.readFile(filePath, { encoding: 'utf8' });
-            const unsafeContent = parse(contentString);
-            try {
-                return validateCategoryMetadataFile(unsafeContent);
-            }
-            catch (e) {
-                console.error(chalk_1.default.red(`The docs sidebar category metadata file looks invalid!\nPath: ${filePath}`));
-                throw e;
-            }
-        }
-        return null;
-    }
-    return ((_b = (_a = (await tryReadFile(`${exports.CategoryMetadataFilenameBase}.json`, JSON.parse))) !== null && _a !== void 0 ? _a : (await tryReadFile(`${exports.CategoryMetadataFilenameBase}.yml`, js_yaml_1.default.load))) !== null && _b !== void 0 ? _b : 
-    // eslint-disable-next-line no-return-await
-    (await tryReadFile(`${exports.CategoryMetadataFilenameBase}.yaml`, js_yaml_1.default.load)));
-}
-// [...parents, tail]
-function parseBreadcrumb(breadcrumb) {
-    return {
-        parents: lodash_1.take(breadcrumb, breadcrumb.length - 1),
-        tail: lodash_1.last(breadcrumb),
-    };
-}
-// Comment for this feature: https://github.com/facebook/docusaurus/issues/3464#issuecomment-818670449
-const DefaultSidebarItemsGenerator = async function defaultSidebarItemsGenerator({ item, docs: allDocs, version, numberPrefixParser, }) {
-    // Doc at the root of the autogenerated sidebar dir
-    function isRootDoc(doc) {
-        return doc.sourceDirName === item.dirName;
-    }
-    // Doc inside a subfolder of the autogenerated sidebar dir
-    function isCategoryDoc(doc) {
-        if (isRootDoc(doc)) {
-            return false;
-        }
-        return (
-        // autogen dir is . and doc is in subfolder
-        item.dirName === '.' ||
-            // autogen dir is not . and doc is in subfolder
-            // "api/myDoc" startsWith "api/" (note "api2/myDoc" is not included)
-            doc.sourceDirName.startsWith(utils_1.addTrailingSlash(item.dirName)));
-    }
-    function isInAutogeneratedDir(doc) {
-        return isRootDoc(doc) || isCategoryDoc(doc);
-    }
-    // autogenDir=a/b and docDir=a/b/c/d => returns c/d
-    // autogenDir=a/b and docDir=a/b => returns .
-    function getDocDirRelativeToAutogenDir(doc) {
-        if (!isInAutogeneratedDir(doc)) {
-            throw new Error('getDocDirRelativeToAutogenDir() can only be called for subdocs of the sidebar autogen dir.');
-        }
-        // Is there a node API to compare 2 relative paths more easily?
-        // path.relative() does not give good results
-        if (item.dirName === '.') {
-            return doc.sourceDirName;
-        }
-        else if (item.dirName === doc.sourceDirName) {
-            return '.';
-        }
-        else {
-            return doc.sourceDirName.replace(utils_1.addTrailingSlash(item.dirName), '');
-        }
-    }
-    // Get only docs in the autogen dir
-    // Sort by folder+filename at once
-    const docs = lodash_1.sortBy(allDocs.filter(isInAutogeneratedDir), (d) => d.source);
-    if (docs.length === 0) {
-        console.warn(chalk_1.default.yellow(`No docs found in dir ${item.dirName}: can't auto-generate a sidebar.`));
-    }
-    function createDocSidebarItem(doc) {
-        return {
-            type: 'doc',
-            id: doc.id,
-            ...(doc.frontMatter.sidebar_label && {
-                label: doc.frontMatter.sidebar_label,
-            }),
-            ...(typeof doc.sidebarPosition !== 'undefined' && {
-                position: doc.sidebarPosition,
-            }),
-        };
-    }
-    async function createCategorySidebarItem({ breadcrumb, }) {
-        var _a, _b, _c;
-        const categoryDirPath = path_1.default.join(version.contentPath, item.dirName, // fix https://github.com/facebook/docusaurus/issues/4638
-        breadcrumb.join(BreadcrumbSeparator));
-        const categoryMetadatas = await readCategoryMetadatasFile(categoryDirPath);
-        const { tail } = parseBreadcrumb(breadcrumb);
-        const { filename, numberPrefix } = numberPrefixParser(tail);
-        const position = (_a = categoryMetadatas === null || categoryMetadatas === void 0 ? void 0 : categoryMetadatas.position) !== null && _a !== void 0 ? _a : numberPrefix;
-        return {
-            type: 'category',
-            label: (_b = categoryMetadatas === null || categoryMetadatas === void 0 ? void 0 : categoryMetadatas.label) !== null && _b !== void 0 ? _b : filename,
-            items: [],
-            collapsed: (_c = categoryMetadatas === null || categoryMetadatas === void 0 ? void 0 : categoryMetadatas.collapsed) !== null && _c !== void 0 ? _c : sidebars_1.DefaultCategoryCollapsedValue,
-            ...(typeof position !== 'undefined' && { position }),
-        };
-    }
-    // Not sure how to simplify this algorithm :/
-    async function autogenerateSidebarItems() {
-        const sidebarItems = []; // mutable result
-        const categoriesByBreadcrumb = {}; // mutable cache of categories already created
-        async function getOrCreateCategoriesForBreadcrumb(breadcrumb) {
-            if (breadcrumb.length === 0) {
-                return null;
-            }
-            const { parents } = parseBreadcrumb(breadcrumb);
-            const parentCategory = await getOrCreateCategoriesForBreadcrumb(parents);
-            const existingCategory = categoriesByBreadcrumb[breadcrumb.join(BreadcrumbSeparator)];
-            if (existingCategory) {
-                return existingCategory;
-            }
-            else {
-                const newCategory = await createCategorySidebarItem({
-                    breadcrumb,
-                });
-                if (parentCategory) {
-                    parentCategory.items.push(newCategory);
-                }
-                else {
-                    sidebarItems.push(newCategory);
-                }
-                categoriesByBreadcrumb[breadcrumb.join(BreadcrumbSeparator)] = newCategory;
-                return newCategory;
-            }
-        }
-        // Get the category breadcrumb of a doc (relative to the dir of the autogenerated sidebar item)
-        function getRelativeBreadcrumb(doc) {
-            const relativeDirPath = getDocDirRelativeToAutogenDir(doc);
-            if (relativeDirPath === '.') {
-                return [];
-            }
-            else {
-                return relativeDirPath.split(BreadcrumbSeparator);
-            }
-        }
-        async function handleDocItem(doc) {
-            const breadcrumb = getRelativeBreadcrumb(doc);
-            const category = await getOrCreateCategoriesForBreadcrumb(breadcrumb);
-            const docSidebarItem = createDocSidebarItem(doc);
-            if (category) {
-                category.items.push(docSidebarItem);
-            }
-            else {
-                sidebarItems.push(docSidebarItem);
-            }
-        }
-        // async process made sequential on purpose! order matters
-        for (const doc of docs) {
-            // eslint-disable-next-line no-await-in-loop
-            await handleDocItem(doc);
-        }
-        return sidebarItems;
-    }
-    const sidebarItems = await autogenerateSidebarItems();
-    return sortSidebarItems(sidebarItems);
-};
-exports.DefaultSidebarItemsGenerator = DefaultSidebarItemsGenerator;
-// Recursively sort the categories/docs + remove the "position" attribute from final output
-// Note: the "position" is only used to sort "inside" a sidebar slice
-// It is not used to sort across multiple consecutive sidebar slices (ie a whole Category composed of multiple autogenerated items)
-function sortSidebarItems(sidebarItems) {
-    const processedSidebarItems = sidebarItems.map((item) => {
-        if (item.type === 'category') {
-            return {
-                ...item,
-                items: sortSidebarItems(item.items),
-            };
-        }
-        return item;
-    });
-    const sortedSidebarItems = lodash_1.orderBy(processedSidebarItems, (item) => item.position, ['asc']);
-    return sortedSidebarItems.map(({ position: _removed, ...item }) => item);
-}

package/lib/sidebars.d.ts

@@ -1,43 +0,0 @@
-/**
- * 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 { Sidebars, SidebarItem, SidebarItemLink, SidebarItemDoc, Sidebar, SidebarItemCategory, UnprocessedSidebars, UnprocessedSidebar, DocMetadataBase, VersionMetadata, SidebarItemsGeneratorDoc, SidebarItemsGeneratorVersion, NumberPrefixParser, SidebarItemsGeneratorOption, PluginOptions } from './types';
-export declare const DefaultCategoryCollapsedValue = true;
-export declare const DefaultSidebars: UnprocessedSidebars;
-export declare const DisabledSidebars: UnprocessedSidebars;
-export declare function resolveSidebarPathOption(siteDir: string, sidebarPathOption: PluginOptions['sidebarPath']): PluginOptions['sidebarPath'];
-export declare function loadSidebars(sidebarFilePath: string | false | undefined): UnprocessedSidebars;
-export declare function toSidebarItemsGeneratorDoc(doc: DocMetadataBase): SidebarItemsGeneratorDoc;
-export declare function toSidebarItemsGeneratorVersion(version: VersionMetadata): SidebarItemsGeneratorVersion;
-export declare function processSidebar({ sidebarItemsGenerator, numberPrefixParser, unprocessedSidebar, docs, version, }: {
-    sidebarItemsGenerator: SidebarItemsGeneratorOption;
-    numberPrefixParser: NumberPrefixParser;
-    unprocessedSidebar: UnprocessedSidebar;
-    docs: DocMetadataBase[];
-    version: VersionMetadata;
-}): Promise<Sidebar>;
-export declare function processSidebars({ sidebarItemsGenerator, numberPrefixParser, unprocessedSidebars, docs, version, }: {
-    sidebarItemsGenerator: SidebarItemsGeneratorOption;
-    numberPrefixParser: NumberPrefixParser;
-    unprocessedSidebars: UnprocessedSidebars;
-    docs: DocMetadataBase[];
-    version: VersionMetadata;
-}): Promise<Sidebars>;
-export declare function collectSidebarDocItems(sidebar: Sidebar): SidebarItemDoc[];
-export declare function collectSidebarCategories(sidebar: Sidebar): SidebarItemCategory[];
-export declare function collectSidebarLinks(sidebar: Sidebar): SidebarItemLink[];
-export declare function transformSidebarItems(sidebar: Sidebar, updateFn: (item: SidebarItem) => SidebarItem): Sidebar;
-export declare function collectSidebarsDocIds(sidebars: Sidebars): Record<string, string[]>;
-export declare function createSidebarsUtils(sidebars: Sidebars): {
-    getFirstDocIdOfFirstSidebar: () => string | undefined;
-    getSidebarNameByDocId: (docId: string) => string | undefined;
-    getDocNavigation: (docId: string) => {
-        sidebarName: string | undefined;
-        previousId: string | undefined;
-        nextId: string | undefined;
-    };
-    checkSidebarsDocIds: (validDocIds: string[], sidebarFilePath: string) => void;
-};