@docusaurus/plugin-content-docs 2.0.0-beta.20 → 2.0.0-beta.21

package/lib/categoryGeneratedIndex.d.ts

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

package/lib/cli.d.ts

@@ -6,4 +6,4 @@
  */
 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>;
+export declare function cliDocsVersionCommand(version: unknown, { id: pluginId, path: docsPath, sidebarPath }: PluginOptions, { siteDir, i18n }: LoadContext): Promise<void>;

package/lib/cli.js

@@ -8,14 +8,14 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.cliDocsVersionCommand = void 0;
 const tslib_1 = require("tslib");
-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 logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
+const utils_1 = require("@docusaurus/utils");
+const files_1 = require("./versions/files");
+const validation_1 = require("./versions/validation");
 const sidebars_1 = require("./sidebars");
 const constants_1 = require("./constants");
-const utils_1 = require("@docusaurus/utils");
-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
@@ -37,16 +37,11 @@ async function cliDocsVersionCommand(version, { id: pluginId, path: docsPath, si
     try {
         (0, validation_1.validateVersionName)(version);
     }
-    catch (e) {
+    catch (err) {
         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, files_1.getVersionsFilePath)(siteDir, pluginId);
-    if (await fs_extra_1.default.pathExists(versionsJSONFile)) {
-        versions = await fs_extra_1.default.readJSON(versionsJSONFile);
+        throw err;
     }
+    const versions = (await (0, files_1.readVersionsFile)(siteDir, pluginId)) ?? [];
     // 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.`);
@@ -92,7 +87,7 @@ async function cliDocsVersionCommand(version, { id: pluginId, path: docsPath, si
     });
     // Update versions.json file.
     versions.unshift(version);
-    await fs_extra_1.default.outputFile(versionsJSONFile, `${JSON.stringify(versions, null, 2)}\n`);
+    await fs_extra_1.default.outputFile((0, files_1.getVersionsFilePath)(siteDir, pluginId), `${JSON.stringify(versions, null, 2)}\n`);
     logger_1.default.success `name=${pluginIdLogPrefix}: version name=${version} created!`;
 }
 exports.cliDocsVersionCommand = cliDocsVersionCommand;

package/lib/client/docsClientUtils.js

@@ -1,22 +1,19 @@
-"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.getDocVersionSuggestions = exports.getActiveDocContext = exports.getActiveVersion = exports.getLatestVersion = exports.getActivePlugin = void 0;
-const router_1 = require("@docusaurus/router");
+import { matchPath } from '@docusaurus/router';
 // This code is not part of the api surface, not in ./theme on purpose
 // 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(allPluginData, pathname, options = {}) {
+export 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, {
+        .find(([, pluginData]) => !!matchPath(pathname, {
         path: pluginData.path,
         exact: false,
         strict: false,
@@ -31,27 +28,24 @@ function getActivePlugin(allPluginData, pathname, options = {}) {
     }
     return activePlugin;
 }
-exports.getActivePlugin = getActivePlugin;
-const getLatestVersion = (data) => data.versions.find((version) => version.isLast);
-exports.getLatestVersion = getLatestVersion;
-function getActiveVersion(data, pathname) {
-    const lastVersion = (0, exports.getLatestVersion)(data);
+export const getLatestVersion = (data) => data.versions.find((version) => version.isLast);
+export function getActiveVersion(data, pathname) {
+    const lastVersion = 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
     const orderedVersionsMetadata = [
         ...data.versions.filter((version) => version !== lastVersion),
         lastVersion,
     ];
-    return orderedVersionsMetadata.find((version) => !!(0, router_1.matchPath)(pathname, {
+    return orderedVersionsMetadata.find((version) => !!matchPath(pathname, {
         path: version.path,
         exact: false,
         strict: false,
     }));
 }
-exports.getActiveVersion = getActiveVersion;
-function getActiveDocContext(data, pathname) {
+export function getActiveDocContext(data, pathname) {
     const activeVersion = getActiveVersion(data, pathname);
-    const activeDoc = activeVersion?.docs.find((doc) => !!(0, router_1.matchPath)(pathname, {
+    const activeDoc = activeVersion?.docs.find((doc) => !!matchPath(pathname, {
         path: doc.path,
         exact: true,
         strict: false,
@@ -76,11 +70,9 @@ function getActiveDocContext(data, pathname) {
         alternateDocVersions: alternateVersionDocs,
     };
 }
-exports.getActiveDocContext = getActiveDocContext;
-function getDocVersionSuggestions(data, pathname) {
-    const latestVersion = (0, exports.getLatestVersion)(data);
+export function getDocVersionSuggestions(data, pathname) {
+    const latestVersion = getLatestVersion(data);
     const activeDocContext = getActiveDocContext(data, pathname);
-    const latestDocSuggestion = activeDocContext?.alternateDocVersions[latestVersion.name];
+    const latestDocSuggestion = activeDocContext.alternateDocVersions[latestVersion.name];
     return { latestDocSuggestion, latestVersionSuggestion: latestVersion };
 }
-exports.getDocVersionSuggestions = getDocVersionSuggestions;

package/lib/client/index.js

@@ -1,72 +1,59 @@
-"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.useDocVersionSuggestions = exports.useActiveDocContext = exports.useActiveVersion = exports.useLatestVersion = exports.useVersions = exports.useActivePluginAndVersion = exports.useActivePlugin = exports.useDocsData = exports.useAllDocsData = void 0;
-const router_1 = require("@docusaurus/router");
-const useGlobalData_1 = require("@docusaurus/useGlobalData");
-const docsClientUtils_1 = require("./docsClientUtils");
+import { useLocation } from '@docusaurus/router';
+import { useAllPluginInstancesData, usePluginData, } from '@docusaurus/useGlobalData';
+import { getActivePlugin, getLatestVersion, getActiveVersion, getActiveDocContext, getDocVersionSuggestions, } from './docsClientUtils';
 // Important to use a constant object to avoid React useEffect executions etc.
 // see https://github.com/facebook/docusaurus/issues/5089
 const 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, {
+export const useAllDocsData = () => useAllPluginInstancesData('docusaurus-plugin-content-docs') ?? StableEmptyObject;
+export const useDocsData = (pluginId) => usePluginData('docusaurus-plugin-content-docs', pluginId, {
     failfast: true,
 });
-exports.useDocsData = useDocsData;
 // TODO this feature should be provided by docusaurus core
-function useActivePlugin(options = {}) {
-    const data = (0, exports.useAllDocsData)();
-    const { pathname } = (0, router_1.useLocation)();
-    return (0, docsClientUtils_1.getActivePlugin)(data, pathname, options);
+export function useActivePlugin(options = {}) {
+    const data = useAllDocsData();
+    const { pathname } = useLocation();
+    return getActivePlugin(data, pathname, options);
 }
-exports.useActivePlugin = useActivePlugin;
-function useActivePluginAndVersion(options = {}) {
+export function useActivePluginAndVersion(options = {}) {
     const activePlugin = useActivePlugin(options);
-    const { pathname } = (0, router_1.useLocation)();
+    const { pathname } = useLocation();
     if (!activePlugin) {
         return undefined;
     }
-    const activeVersion = (0, docsClientUtils_1.getActiveVersion)(activePlugin.pluginData, pathname);
+    const activeVersion = getActiveVersion(activePlugin.pluginData, pathname);
     return {
         activePlugin,
         activeVersion,
     };
 }
-exports.useActivePluginAndVersion = useActivePluginAndVersion;
-function useVersions(pluginId) {
-    const data = (0, exports.useDocsData)(pluginId);
+export function useVersions(pluginId) {
+    const data = useDocsData(pluginId);
     return data.versions;
 }
-exports.useVersions = useVersions;
-function useLatestVersion(pluginId) {
-    const data = (0, exports.useDocsData)(pluginId);
-    return (0, docsClientUtils_1.getLatestVersion)(data);
+export function useLatestVersion(pluginId) {
+    const data = useDocsData(pluginId);
+    return getLatestVersion(data);
 }
-exports.useLatestVersion = useLatestVersion;
-function useActiveVersion(pluginId) {
-    const data = (0, exports.useDocsData)(pluginId);
-    const { pathname } = (0, router_1.useLocation)();
-    return (0, docsClientUtils_1.getActiveVersion)(data, pathname);
+export function useActiveVersion(pluginId) {
+    const data = useDocsData(pluginId);
+    const { pathname } = useLocation();
+    return getActiveVersion(data, pathname);
 }
-exports.useActiveVersion = useActiveVersion;
-function useActiveDocContext(pluginId) {
-    const data = (0, exports.useDocsData)(pluginId);
-    const { pathname } = (0, router_1.useLocation)();
-    return (0, docsClientUtils_1.getActiveDocContext)(data, pathname);
+export function useActiveDocContext(pluginId) {
+    const data = useDocsData(pluginId);
+    const { pathname } = useLocation();
+    return getActiveDocContext(data, pathname);
 }
-exports.useActiveDocContext = useActiveDocContext;
-function useDocVersionSuggestions(pluginId) {
-    const data = (0, exports.useDocsData)(pluginId);
-    const { pathname } = (0, router_1.useLocation)();
-    return (0, docsClientUtils_1.getDocVersionSuggestions)(data, pathname);
+export function useDocVersionSuggestions(pluginId) {
+    const data = useDocsData(pluginId);
+    const { pathname } = useLocation();
+    return getDocVersionSuggestions(data, pathname);
 }
-exports.useDocVersionSuggestions = useDocVersionSuggestions;

package/lib/docs.d.ts

@@ -4,10 +4,10 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+import type { MetadataOptions, PluginOptions, CategoryIndexMatcher, DocMetadataBase, VersionMetadata, LoadedVersion } from '@docusaurus/plugin-content-docs';
 import type { LoadContext } from '@docusaurus/types';
-import type { DocFile } from './types';
 import type { SidebarsUtils } from './sidebars/utils';
-import type { MetadataOptions, PluginOptions, CategoryIndexMatcher, DocMetadataBase, VersionMetadata, LoadedVersion } from '@docusaurus/plugin-content-docs';
+import type { DocFile } from './types';
 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[]>;

package/lib/index.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 { LoadContext, Plugin } from '@docusaurus/types';
 import type { PluginOptions, LoadedContent } from '@docusaurus/plugin-content-docs';
+import type { LoadContext, Plugin } from '@docusaurus/types';
 export default function pluginContentDocs(context: LoadContext, options: PluginOptions): Promise<Plugin<LoadedContent>>;
 export { validateOptions } from './options';

package/lib/index.js

@@ -9,6 +9,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateOptions = void 0;
 const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const utils_1 = require("@docusaurus/utils");
 const sidebars_1 = require("./sidebars");
 const generator_1 = require("./sidebars/generator");
@@ -20,11 +22,9 @@ const globalData_1 = require("./globalData");
 const props_1 = require("./props");
 const categoryGeneratedIndex_1 = require("./categoryGeneratedIndex");
 const translations_1 = require("./translations");
-const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const tags_1 = require("./tags");
 const routes_1 = require("./routes");
 const utils_2 = require("./sidebars/utils");
-const lodash_1 = tslib_1.__importDefault(require("lodash"));
 async function pluginContentDocs(context, options) {
     const { siteDir, generatedFilesDir, baseUrl, siteConfig } = context;
     // Mutate options to resolve sidebar path according to siteDir
@@ -76,7 +76,7 @@ async function pluginContentDocs(context, options) {
                 if (docFiles.length === 0) {
                     throw new Error(`Docs version "${versionMetadata.versionName}" has no docs! At least one doc should exist at "${path_1.default.relative(siteDir, versionMetadata.contentPath)}".`);
                 }
-                async function processVersionDoc(docFile) {
+                function processVersionDoc(docFile) {
                     return (0, docs_1.processDocMetadata)({
                         docFile,
                         versionMetadata,

package/lib/markdown/index.js

@@ -11,6 +11,6 @@ function markdownLoader(source) {
     const fileString = source;
     const callback = this.async();
     const options = this.getOptions();
-    return callback?.(null, (0, linkify_1.linkify)(fileString, this.resourcePath, options));
+    return callback(null, (0, linkify_1.linkify)(fileString, this.resourcePath, options));
 }
 exports.default = markdownLoader;

package/lib/options.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 { PluginOptions, Options } from '@docusaurus/plugin-content-docs';
 import type { OptionValidationContext } from '@docusaurus/types';
+import type { PluginOptions, Options } from '@docusaurus/plugin-content-docs';
 export declare const DEFAULT_OPTIONS: Omit<PluginOptions, 'id' | 'sidebarPath'>;
 export declare function validateOptions({ validate, options: userOptions, }: OptionValidationContext<Options, PluginOptions>): PluginOptions;

package/lib/options.js

@@ -8,9 +8,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateOptions = exports.DEFAULT_OPTIONS = void 0;
 const tslib_1 = require("tslib");
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const utils_1 = require("@docusaurus/utils");
-const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const remark_admonitions_1 = tslib_1.__importDefault(require("remark-admonitions"));
 const generator_1 = require("./sidebars/generator");
 const numberPrefix_1 = require("./numberPrefix");

package/lib/props.js

@@ -26,7 +26,7 @@ Available document ids are:
         const { title, permalink, frontMatter: { sidebar_label: sidebarLabel }, } = docMetadata;
         return {
             type: 'link',
-            label: sidebarLabel || item.label || title,
+            label: sidebarLabel ?? item.label ?? title,
             href: permalink,
             className: item.className,
             customProps: item.customProps ?? docMetadata.frontMatter.sidebar_custom_props,

package/lib/routes.js

@@ -8,9 +8,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createVersionRoutes = exports.createDocRoutes = exports.createCategoryGeneratedIndexRoutes = void 0;
 const tslib_1 = require("tslib");
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const utils_1 = require("@docusaurus/utils");
 const props_1 = require("./props");
-const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 async function createCategoryGeneratedIndexRoutes({ version, actions, docCategoryGeneratedIndexComponent, aliasedSource, }) {
     const slugs = (0, utils_1.createSlugger)();
     async function createCategoryGeneratedIndexRoute(categoryGeneratedIndex) {

package/lib/sidebars/generator.js

@@ -8,10 +8,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DefaultSidebarItemsGenerator = exports.CategoryMetadataFilenamePattern = exports.CategoryMetadataFilenameBase = void 0;
 const tslib_1 = require("tslib");
+const path_1 = tslib_1.__importDefault(require("path"));
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
-const utils_1 = require("@docusaurus/utils");
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
-const path_1 = tslib_1.__importDefault(require("path"));
+const utils_1 = require("@docusaurus/utils");
 const docs_1 = require("../docs");
 const BreadcrumbSeparator = '/';
 // Just an alias to the make code more explicit
@@ -21,7 +21,7 @@ function getLocalDocId(docId) {
 exports.CategoryMetadataFilenameBase = '_category_';
 exports.CategoryMetadataFilenamePattern = '_category_.{json,yml,yaml}';
 // Comment for this feature: https://github.com/facebook/docusaurus/issues/3464#issuecomment-818670449
-const DefaultSidebarItemsGenerator = async ({ numberPrefixParser, isCategoryIndex, docs: allDocs, item: { dirName: autogenDir }, categoriesMetadata, }) => {
+const DefaultSidebarItemsGenerator = ({ numberPrefixParser, isCategoryIndex, docs: allDocs, item: { dirName: autogenDir }, categoriesMetadata, }) => {
     const docsById = (0, docs_1.createDocsByIdIndex)(allDocs);
     const findDoc = (docId) => docsById[docId];
     const getDoc = (docId) => {

package/lib/sidebars/index.d.ts

@@ -4,8 +4,8 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { SidebarsConfig, Sidebars, SidebarProcessorParams } from './types';
 import type { PluginOptions } from '@docusaurus/plugin-content-docs';
+import type { SidebarsConfig, Sidebars, SidebarProcessorParams } from './types';
 export declare const DefaultSidebars: SidebarsConfig;
 export declare const DisabledSidebars: SidebarsConfig;
 export declare function resolveSidebarPathOption(siteDir: string, sidebarPathOption: PluginOptions['sidebarPath']): PluginOptions['sidebarPath'];

package/lib/sidebars/index.js

@@ -9,17 +9,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadSidebars = exports.loadSidebarsFileUnsafe = exports.resolveSidebarPathOption = exports.DisabledSidebars = exports.DefaultSidebars = void 0;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const path_1 = tslib_1.__importDefault(require("path"));
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
+const utils_1 = require("@docusaurus/utils");
+const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
+const combine_promises_1 = tslib_1.__importDefault(require("combine-promises"));
 const import_fresh_1 = tslib_1.__importDefault(require("import-fresh"));
 const validation_1 = require("./validation");
 const normalization_1 = require("./normalization");
 const processor_1 = require("./processor");
 const postProcessor_1 = require("./postProcessor");
-const path_1 = tslib_1.__importDefault(require("path"));
-const utils_1 = require("@docusaurus/utils");
-const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
-const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
-const lodash_1 = tslib_1.__importDefault(require("lodash"));
-const combine_promises_1 = tslib_1.__importDefault(require("combine-promises"));
 exports.DefaultSidebars = {
     defaultSidebar: [
         {

package/lib/sidebars/normalization.js

@@ -8,9 +8,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.normalizeSidebars = exports.normalizeItem = void 0;
 const tslib_1 = require("tslib");
-const utils_1 = require("./utils");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
+const utils_1 = require("./utils");
 function normalizeCategoriesShorthand(sidebar) {
     return Object.entries(sidebar).map(([label, items]) => ({
         type: 'category',

package/lib/sidebars/postProcessor.d.ts

@@ -5,4 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { Sidebars, SidebarProcessorParams, ProcessedSidebars } from './types';
+export declare type SidebarPostProcessorParams = SidebarProcessorParams & {
+    draftIds: Set<string>;
+};
 export declare function postProcessSidebars(sidebars: ProcessedSidebars, params: SidebarProcessorParams): Sidebars;

package/lib/sidebars/postProcessor.js

@@ -8,9 +8,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.postProcessSidebars = void 0;
 const tslib_1 = require("tslib");
-const utils_1 = require("@docusaurus/utils");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const utils_1 = require("@docusaurus/utils");
+const docs_1 = require("../docs");
 function normalizeCategoryLink(category, params) {
+    if (category.link?.type === 'doc' && params.draftIds.has(category.link.id)) {
+        return undefined;
+    }
     if (category.link?.type === 'generated-index') {
         // Default slug logic can be improved
         const getDefaultSlug = () => `/category/${params.categoryLabelSlugger.slug(category.label)}`;
@@ -26,40 +30,52 @@ function normalizeCategoryLink(category, params) {
 }
 function postProcessSidebarItem(item, params) {
     if (item.type === 'category') {
+        // Fail-fast if there's actually no subitems, no because all subitems are
+        // drafts. This is likely a configuration mistake.
+        if (item.items.length === 0 && !item.link) {
+            throw new Error(`Sidebar category ${item.label} has neither any subitem nor a link. This makes this item not able to link to anything.`);
+        }
         const category = {
             ...item,
             collapsed: item.collapsed ?? params.sidebarOptions.sidebarCollapsed,
             collapsible: item.collapsible ?? params.sidebarOptions.sidebarCollapsible,
             link: normalizeCategoryLink(item, params),
-            items: item.items.map((subItem) => postProcessSidebarItem(subItem, params)),
+            items: item.items
+                .map((subItem) => postProcessSidebarItem(subItem, params))
+                .filter((v) => Boolean(v)),
         };
         // If the current category doesn't have subitems, we render a normal link
         // instead.
         if (category.items.length === 0) {
-            if (!category.link) {
-                throw new Error(`Sidebar category ${item.label} has neither any subitem nor a link. This makes this item not able to link to anything.`);
+            // Doesn't make sense to render an empty generated index page, so we
+            // filter the entire category out as well.
+            if (!category.link ||
+                category.link.type === 'generated-index' ||
+                params.draftIds.has(category.link.id)) {
+                return null;
             }
-            return category.link.type === 'doc'
-                ? {
-                    type: 'doc',
-                    label: category.label,
-                    id: category.link.id,
-                }
-                : {
-                    type: 'link',
-                    label: category.label,
-                    href: category.link.permalink,
-                };
+            return {
+                type: 'doc',
+                label: category.label,
+                id: category.link.id,
+            };
         }
         // A non-collapsible category can't be collapsed!
-        if (category.collapsible === false) {
+        if (!category.collapsible) {
             category.collapsed = false;
         }
         return category;
     }
+    if ((item.type === 'doc' || item.type === 'ref') &&
+        params.draftIds.has(item.id)) {
+        return null;
+    }
     return item;
 }
 function postProcessSidebars(sidebars, params) {
-    return lodash_1.default.mapValues(sidebars, (sidebar) => sidebar.map((item) => postProcessSidebarItem(item, params)));
+    const draftIds = new Set(params.drafts.flatMap(docs_1.getDocIds));
+    return lodash_1.default.mapValues(sidebars, (sidebar) => sidebar
+        .map((item) => postProcessSidebarItem(item, { ...params, draftIds }))
+        .filter((v) => Boolean(v)));
 }
 exports.postProcessSidebars = postProcessSidebars;

package/lib/sidebars/processor.js

@@ -8,10 +8,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.processSidebars = void 0;
 const tslib_1 = require("tslib");
-const generator_1 = require("./generator");
-const validation_1 = require("./validation");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const combine_promises_1 = tslib_1.__importDefault(require("combine-promises"));
+const generator_1 = require("./generator");
+const validation_1 = require("./validation");
 const docs_1 = require("../docs");
 function toSidebarItemsGeneratorDoc(doc) {
     return lodash_1.default.pick(doc, [
@@ -30,7 +30,7 @@ function toSidebarItemsGeneratorVersion(version) {
 // Handle the generation of autogenerated sidebar items and other
 // post-processing checks
 async function processSidebar(unprocessedSidebar, categoriesMetadata, params) {
-    const { sidebarItemsGenerator, numberPrefixParser, docs, drafts, version } = params;
+    const { sidebarItemsGenerator, numberPrefixParser, docs, version } = params;
     // Just a minor lazy transformation optimization
     const getSidebarItemsGeneratorDocsAndVersion = lodash_1.default.memoize(() => ({
         docs: docs.map(toSidebarItemsGeneratorDoc),
@@ -51,23 +51,12 @@ async function processSidebar(unprocessedSidebar, categoriesMetadata, params) {
         // more autogenerated items, or when loop count (e.g. 10) is reached
         return processItems(generatedItems);
     }
-    const draftIds = new Set(drafts.flatMap(docs_1.getDocIds));
-    const isDraftItem = (item) => {
-        if (item.type === 'doc' || item.type === 'ref') {
-            return draftIds.has(item.id);
-        }
-        // If a category only contains draft items, it should be filtered entirely.
-        if (item.type === 'category') {
-            return item.items.every(isDraftItem);
-        }
-        return false;
-    };
     async function processItem(item) {
         if (item.type === 'category') {
             return [
                 {
                     ...item,
-                    items: await processItems(item.items),
+                    items: (await Promise.all(item.items.map(processItem))).flat(),
                 },
             ];
         }
@@ -77,7 +66,7 @@ async function processSidebar(unprocessedSidebar, categoriesMetadata, params) {
         return [item];
     }
     async function processItems(items) {
-        return (await Promise.all(items.filter((i) => !isDraftItem(i)).map(processItem))).flat();
+        return (await Promise.all(items.map(processItem))).flat();
     }
     const processedSidebar = await processItems(unprocessedSidebar);
     return processedSidebar;

package/lib/sidebars/types.d.ts

@@ -157,7 +157,7 @@ export declare type SidebarItemsGeneratorArgs = {
         [filePath: string]: CategoryMetadataFile;
     };
 };
-export declare type SidebarItemsGenerator = (generatorArgs: SidebarItemsGeneratorArgs) => Promise<NormalizedSidebar>;
+export declare type SidebarItemsGenerator = (generatorArgs: SidebarItemsGeneratorArgs) => NormalizedSidebar | Promise<NormalizedSidebar>;
 export declare type SidebarItemsGeneratorOption = (generatorArgs: {
     /**
      * Useful to re-use/enhance the default sidebar generation logic from
@@ -165,7 +165,7 @@ export declare type SidebarItemsGeneratorOption = (generatorArgs: {
      * @see https://github.com/facebook/docusaurus/issues/4640#issuecomment-822292320
      */
     defaultSidebarItemsGenerator: SidebarItemsGenerator;
-} & SidebarItemsGeneratorArgs) => Promise<NormalizedSidebarItem[]>;
+} & SidebarItemsGeneratorArgs) => NormalizedSidebar | Promise<NormalizedSidebar>;
 export declare type SidebarProcessorParams = {
     sidebarItemsGenerator: SidebarItemsGeneratorOption;
     numberPrefixParser: NumberPrefixParser;

package/lib/sidebars/utils.js

@@ -158,7 +158,7 @@ function createSidebarsUtils(sidebars) {
     function getCategoryGeneratedIndexNavigation(categoryGeneratedIndexPermalink) {
         function isCurrentCategoryGeneratedIndexItem(item) {
             return (item.type === 'category' &&
-                item.link?.type === 'generated-index' &&
+                item.link.type === 'generated-index' &&
                 item.link.permalink === categoryGeneratedIndexPermalink);
         }
         const sidebarName = Object.entries(sidebarNameToNavigationItems).find(([, navigationItems]) => navigationItems.find(isCurrentCategoryGeneratedIndexItem))[0];

package/lib/sidebars/validation.js

@@ -133,6 +133,10 @@ const categoryMetadataFileSchema = utils_validation_1.Joi.object({
     customProps: utils_validation_1.Joi.object().unknown(),
 });
 function validateCategoryMetadataFile(unsafeContent) {
-    return utils_validation_1.Joi.attempt(unsafeContent, categoryMetadataFileSchema);
+    const { error, value } = categoryMetadataFileSchema.validate(unsafeContent);
+    if (error) {
+        throw error;
+    }
+    return value;
 }
 exports.validateCategoryMetadataFile = validateCategoryMetadataFile;

package/lib/slug.js

@@ -28,7 +28,7 @@ function getSlug({ baseID, frontMatterSlug, source, sourceDirName, stripDirNumbe
             (0, docs_1.isCategoryIndex)((0, docs_1.toCategoryIndexMatcherParam)({ source, sourceDirName }))) {
             return dirNameSlug;
         }
-        const baseSlug = frontMatterSlug || baseID;
+        const baseSlug = frontMatterSlug ?? baseID;
         return (0, utils_1.resolvePathname)(baseSlug, getDirNameSlug());
     }
     function ensureValidSlug(slug) {