@docusaurus/plugin-content-docs 2.4.1 → 3.0.0-beta.0

package/lib/client/index.d.ts

@@ -5,18 +5,18 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { UseDataOptions } from '@docusaurus/types';
-export declare type ActivePlugin = {
+export type ActivePlugin = {
     pluginId: string;
     pluginData: GlobalPluginData;
 };
-export declare type ActiveDocContext = {
+export type ActiveDocContext = {
     activeVersion?: GlobalVersion;
     activeDoc?: GlobalDoc;
     alternateDocVersions: {
         [versionName: string]: GlobalDoc;
     };
 };
-export declare type GlobalDoc = {
+export type GlobalDoc = {
     /**
      * For generated index pages, this is the `slug`, **not** `permalink`
      * (without base URL). Because slugs have leading slashes but IDs don't,
@@ -24,9 +24,10 @@ export declare type GlobalDoc = {
      */
     id: string;
     path: string;
-    sidebar: string | undefined;
+    sidebar?: string;
+    unlisted?: boolean;
 };
-export declare type GlobalVersion = {
+export type GlobalVersion = {
     name: string;
     label: string;
     isLast: boolean;
@@ -40,18 +41,18 @@ export declare type GlobalVersion = {
         [sidebarId: string]: GlobalSidebar;
     };
 };
-export declare type GlobalSidebar = {
+export type GlobalSidebar = {
     link?: {
         label: string;
         path: string;
     };
 };
-export declare type GlobalPluginData = {
+export type GlobalPluginData = {
     path: string;
     versions: GlobalVersion[];
     breadcrumbs: boolean;
 };
-export declare type DocVersionSuggestions = {
+export type DocVersionSuggestions = {
     /** Suggest the latest version */
     latestVersionSuggestion: GlobalVersion;
     /** Suggest the same doc, in latest version (if one exists) */

package/lib/docs.d.ts

@@ -10,7 +10,7 @@ import type { SidebarsUtils } from './sidebars/utils';
 import type { DocFile } from './types';
 export declare function readDocFile(versionMetadata: Pick<VersionMetadata, 'contentPath' | 'contentPathLocalized'>, source: string): Promise<DocFile>;
 export declare function readVersionDocs(versionMetadata: VersionMetadata, options: Pick<PluginOptions, 'include' | 'exclude' | 'showLastUpdateAuthor' | 'showLastUpdateTime'>): Promise<DocFile[]>;
-export declare type DocEnv = 'production' | 'development';
+export type DocEnv = 'production' | 'development';
 export declare function processDocMetadata(args: {
     docFile: DocFile;
     versionMetadata: VersionMetadata;
@@ -18,7 +18,10 @@ export declare function processDocMetadata(args: {
     options: MetadataOptions;
     env: DocEnv;
 }): Promise<DocMetadataBase>;
-export declare function addDocNavigation(docsBase: DocMetadataBase[], sidebarsUtils: SidebarsUtils, sidebarFilePath: string): LoadedVersion['docs'];
+export declare function addDocNavigation({ docs, sidebarsUtils, }: {
+    docs: DocMetadataBase[];
+    sidebarsUtils: SidebarsUtils;
+}): LoadedVersion['docs'];
 /**
  * The "main doc" is the "version entry point"
  * We browse this doc by clicking on a version:
@@ -36,10 +39,8 @@ export declare const isCategoryIndex: CategoryIndexMatcher;
  *   `'autogenerated', '.md', ['sidebar', 'guides']`
  */
 export declare function toCategoryIndexMatcherParam({ source, sourceDirName, }: Pick<DocMetadataBase, 'source' | 'sourceDirName'>): Parameters<CategoryIndexMatcher>[0];
-export declare function getDocIds(doc: DocMetadataBase): [string, string];
 export declare function createDocsByIdIndex<Doc extends {
     id: string;
-    unversionedId: string;
 }>(docs: Doc[]): {
     [docId: string]: Doc;
 };

package/lib/docs.js

@@ -6,15 +6,15 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createDocsByIdIndex = exports.getDocIds = exports.toCategoryIndexMatcherParam = exports.isCategoryIndex = exports.getMainDocId = exports.addDocNavigation = exports.processDocMetadata = exports.readVersionDocs = exports.readDocFile = void 0;
+exports.createDocsByIdIndex = exports.toCategoryIndexMatcherParam = exports.isCategoryIndex = exports.getMainDocId = exports.addDocNavigation = exports.processDocMetadata = exports.readVersionDocs = exports.readDocFile = void 0;
 const tslib_1 = require("tslib");
 const path_1 = tslib_1.__importDefault(require("path"));
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const utils_1 = require("@docusaurus/utils");
 const lastUpdate_1 = require("./lastUpdate");
 const slug_1 = tslib_1.__importDefault(require("./slug"));
-const constants_1 = require("./constants");
 const numberPrefix_1 = require("./numberPrefix");
 const frontMatter_1 = require("./frontMatter");
 const utils_2 = require("./sidebars/utils");
@@ -64,10 +64,6 @@ async function readVersionDocs(versionMetadata, options) {
     return Promise.all(sources.map((source) => readDocFile(versionMetadata, source)));
 }
 exports.readVersionDocs = readVersionDocs;
-/** Docs with draft front matter are only considered draft in production. */
-function isDraftForEnvironment({ env, frontMatter, }) {
-    return (env === 'production' && frontMatter.draft) ?? false;
-}
 async function doProcessDocMetadata({ docFile, versionMetadata, context, options, env, }) {
     const { source, content, contentPath, filePath } = docFile;
     const { siteDir, i18n } = context;
@@ -94,12 +90,6 @@ async function doProcessDocMetadata({ docFile, versionMetadata, context, options
     // prefix or front matter
     const sidebarPosition = frontMatter.sidebar_position ?? numberPrefix;
     // TODO legacy retrocompatibility
-    // The same doc in 2 distinct version could keep the same id,
-    // we just need to namespace the data by version
-    const versionIdPrefix = versionMetadata.versionName === constants_1.CURRENT_VERSION_NAME
-        ? undefined
-        : `version-${versionMetadata.versionName}`;
-    // TODO legacy retrocompatibility
     // I think it's bad to affect the front matter id with the dirname?
     function computeDirNameIdPrefix() {
         if (sourceDirName === '.') {
@@ -110,12 +100,7 @@ async function doProcessDocMetadata({ docFile, versionMetadata, context, options
             ? (0, numberPrefix_1.stripPathNumberPrefixes)(sourceDirName, options.numberPrefixParser)
             : sourceDirName;
     }
-    const unversionedId = [computeDirNameIdPrefix(), baseID]
-        .filter(Boolean)
-        .join('/');
-    // TODO is versioning the id very useful in practice?
-    // legacy versioned id, requires a breaking change to modify this
-    const id = [versionIdPrefix, unversionedId].filter(Boolean).join('/');
+    const id = [computeDirNameIdPrefix(), baseID].filter(Boolean).join('/');
     const docSlug = (0, slug_1.default)({
         baseID,
         source,
@@ -150,7 +135,8 @@ async function doProcessDocMetadata({ docFile, versionMetadata, context, options
         }
         return undefined;
     }
-    const draft = isDraftForEnvironment({ env, frontMatter });
+    const draft = (0, utils_1.isDraft)({ env, frontMatter });
+    const unlisted = (0, utils_1.isUnlisted)({ env, frontMatter });
     const formatDate = (locale, date, calendar) => {
         try {
             return new Intl.DateTimeFormat(locale, {
@@ -171,7 +157,6 @@ async function doProcessDocMetadata({ docFile, versionMetadata, context, options
     // Adding properties to object after instantiation will cause hidden
     // class transitions.
     return {
-        unversionedId,
         id,
         title,
         description,
@@ -180,6 +165,7 @@ async function doProcessDocMetadata({ docFile, versionMetadata, context, options
         slug: docSlug,
         permalink,
         draft,
+        unlisted,
         editUrl: customEditURL !== undefined ? customEditURL : getDocEditUrl(),
         tags: (0, utils_1.normalizeFrontMatterTags)(versionMetadata.tagsPath, frontMatter.tags),
         version: versionMetadata.versionName,
@@ -201,12 +187,19 @@ async function processDocMetadata(args) {
     }
 }
 exports.processDocMetadata = processDocMetadata;
-function addDocNavigation(docsBase, sidebarsUtils, sidebarFilePath) {
-    const docsById = createDocsByIdIndex(docsBase);
-    sidebarsUtils.checkSidebarsDocIds(docsBase.flatMap(getDocIds), sidebarFilePath);
+function getUnlistedIds(docs) {
+    return new Set(docs.filter((doc) => doc.unlisted).map((doc) => doc.id));
+}
+function addDocNavigation({ docs, sidebarsUtils, }) {
+    const docsById = createDocsByIdIndex(docs);
+    const unlistedIds = getUnlistedIds(docs);
     // Add sidebar/next/previous to the docs
     function addNavData(doc) {
-        const navigation = sidebarsUtils.getDocNavigation(doc.unversionedId, doc.id, doc.frontMatter.displayed_sidebar);
+        const navigation = sidebarsUtils.getDocNavigation({
+            docId: doc.id,
+            displayedSidebar: doc.frontMatter.displayed_sidebar,
+            unlistedIds,
+        });
         const toNavigationLinkByDocId = (docId, type) => {
             if (!docId) {
                 return undefined;
@@ -216,6 +209,10 @@ function addDocNavigation(docsBase, sidebarsUtils, sidebarFilePath) {
                 // This could only happen if user provided the ID through front matter
                 throw new Error(`Error when loading ${doc.id} in ${doc.sourceDirName}: the pagination_${type} front matter points to a non-existent ID ${docId}.`);
             }
+            // Gracefully handle explicitly providing an unlisted doc ID in production
+            if (navDoc.unlisted) {
+                return undefined;
+            }
             return (0, utils_2.toDocNavigationLink)(navDoc);
         };
         const previous = doc.frontMatter.pagination_prev !== undefined
@@ -226,7 +223,7 @@ function addDocNavigation(docsBase, sidebarsUtils, sidebarFilePath) {
             : (0, utils_2.toNavigationLink)(navigation.next, docsById);
         return { ...doc, sidebar: navigation.sidebarName, previous, next };
     }
-    const docsWithNavigation = docsBase.map(addNavData);
+    const docsWithNavigation = docs.map(addNavData);
     // Sort to ensure consistent output for tests
     docsWithNavigation.sort((a, b) => a.id.localeCompare(b.id));
     return docsWithNavigation;
@@ -247,12 +244,11 @@ function getMainDocId({ docs, sidebarsUtils, }) {
             return versionHomeDoc;
         }
         else if (firstDocIdOfFirstSidebar) {
-            return docs.find((doc) => doc.id === firstDocIdOfFirstSidebar ||
-                doc.unversionedId === firstDocIdOfFirstSidebar);
+            return docs.find((doc) => doc.id === firstDocIdOfFirstSidebar);
         }
         return docs[0];
     }
-    return getMainDoc().unversionedId;
+    return getMainDoc().id;
 }
 exports.getMainDocId = getMainDocId;
 // By convention, Docusaurus considers some docs are "indexes":
@@ -287,22 +283,8 @@ function toCategoryIndexMatcherParam({ source, sourceDirName, }) {
     };
 }
 exports.toCategoryIndexMatcherParam = toCategoryIndexMatcherParam;
-// Return both doc ids
-// TODO legacy retro-compatibility due to old versioned sidebars using
-// versioned doc ids ("id" should be removed & "versionedId" should be renamed
-// to "id")
-function getDocIds(doc) {
-    return [doc.unversionedId, doc.id];
-}
-exports.getDocIds = getDocIds;
-// Docs are indexed by both versioned and unversioned ids at the same time
-// TODO legacy retro-compatibility due to old versioned sidebars using
-// versioned doc ids ("id" should be removed & "versionedId" should be renamed
-// to "id")
+// Docs are indexed by their id
 function createDocsByIdIndex(docs) {
-    return Object.fromEntries(docs.flatMap((doc) => [
-        [doc.unversionedId, doc],
-        [doc.id, doc],
-    ]));
+    return lodash_1.default.keyBy(docs, (d) => d.id);
 }
 exports.createDocsByIdIndex = createDocsByIdIndex;

package/lib/frontMatter.js

@@ -35,7 +35,6 @@ const DocFrontMatterSchema = utils_validation_1.JoiFrontMatter.object({
     parse_number_prefixes: utils_validation_1.JoiFrontMatter.boolean(),
     pagination_next: utils_validation_1.JoiFrontMatter.string().allow(null),
     pagination_prev: utils_validation_1.JoiFrontMatter.string().allow(null),
-    draft: utils_validation_1.JoiFrontMatter.boolean(),
     ...utils_validation_1.FrontMatterTOCHeadingLevels,
     last_update: utils_validation_1.JoiFrontMatter.object({
         author: utils_validation_1.JoiFrontMatter.string(),
@@ -46,7 +45,9 @@ const DocFrontMatterSchema = utils_validation_1.JoiFrontMatter.object({
         'object.missing': FrontMatterLastUpdateErrorMessage,
         'object.base': FrontMatterLastUpdateErrorMessage,
     }),
-}).unknown();
+})
+    .unknown()
+    .concat(utils_validation_1.ContentVisibilitySchema);
 function validateDocFrontMatter(frontMatter) {
     return (0, utils_validation_1.validateFrontMatter)(frontMatter, DocFrontMatterSchema);
 }

package/lib/globalData.js

@@ -12,8 +12,11 @@ const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const docs_1 = require("./docs");
 function toGlobalDataDoc(doc) {
     return {
-        id: doc.unversionedId,
+        id: doc.id,
         path: doc.permalink,
+        // optimize global data size: do not add unlisted: false/undefined
+        ...(doc.unlisted && { unlisted: doc.unlisted }),
+        // TODO optimize size? remove attribute when no sidebar (breaking change?)
         sidebar: doc.sidebar,
     };
 }
@@ -34,7 +37,7 @@ function toGlobalSidebars(sidebars, version) {
             link: {
                 path: firstLink.type === 'generated-index'
                     ? firstLink.permalink
-                    : version.docs.find((doc) => doc.id === firstLink.id || doc.unversionedId === firstLink.id).permalink,
+                    : version.docs.find((doc) => doc.id === firstLink.id).permalink,
                 label: firstLink.label,
             },
         };
@@ -50,7 +53,7 @@ function toGlobalDataVersion(version) {
         docs: version.docs
             .map(toGlobalDataDoc)
             .concat(version.categoryGeneratedIndices.map(toGlobalDataGeneratedIndex)),
-        draftIds: version.drafts.map((doc) => doc.unversionedId),
+        draftIds: version.drafts.map((doc) => doc.id),
         sidebars: toGlobalSidebars(version.sidebars, version),
     };
 }

package/lib/index.js

@@ -19,10 +19,7 @@ const versions_1 = require("./versions");
 const cli_1 = require("./cli");
 const constants_1 = require("./constants");
 const globalData_1 = require("./globalData");
-const props_1 = require("./props");
-const categoryGeneratedIndex_1 = require("./categoryGeneratedIndex");
 const translations_1 = require("./translations");
-const tags_1 = require("./tags");
 const routes_1 = require("./routes");
 const utils_2 = require("./sidebars/utils");
 async function pluginContentDocs(context, options) {
@@ -34,6 +31,8 @@ async function pluginContentDocs(context, options) {
     const pluginDataDirRoot = path_1.default.join(generatedFilesDir, 'docusaurus-plugin-content-docs');
     const dataDir = path_1.default.join(pluginDataDirRoot, pluginId);
     const aliasedSource = (source) => `~docs/${(0, utils_1.posixPath)(path_1.default.relative(pluginDataDirRoot, source))}`;
+    // TODO env should be injected into all plugins
+    const env = process.env.NODE_ENV;
     return {
         name: 'docusaurus-plugin-content-docs',
         extendCli(cli) {
@@ -80,13 +79,16 @@ async function pluginContentDocs(context, options) {
                         versionMetadata,
                         context,
                         options,
-                        env: process.env.NODE_ENV,
+                        env,
                     });
                 }
                 return Promise.all(docFiles.map(processVersionDoc));
             }
             async function doLoadVersion(versionMetadata) {
                 const docsBase = await loadVersionDocsBase(versionMetadata);
+                // TODO we only ever need draftIds in further code, not full draft items
+                // To simplify and prevent mistakes, avoid exposing draft
+                // replace draft=>draftIds in content loaded
                 const [drafts, docs] = lodash_1.default.partition(docsBase, (doc) => doc.draft);
                 const sidebars = await (0, sidebars_1.loadSidebars)(versionMetadata.sidebarFilePath, {
                     sidebarItemsGenerator: options.sidebarItemsGenerator,
@@ -101,9 +103,23 @@ async function pluginContentDocs(context, options) {
                     categoryLabelSlugger: (0, utils_1.createSlugger)(),
                 });
                 const sidebarsUtils = (0, utils_2.createSidebarsUtils)(sidebars);
+                const docsById = (0, docs_1.createDocsByIdIndex)(docs);
+                const allDocIds = Object.keys(docsById);
+                sidebarsUtils.checkLegacyVersionedSidebarNames({
+                    sidebarFilePath: versionMetadata.sidebarFilePath,
+                    versionMetadata,
+                });
+                sidebarsUtils.checkSidebarsDocIds({
+                    allDocIds,
+                    sidebarFilePath: versionMetadata.sidebarFilePath,
+                    versionMetadata,
+                });
                 return {
                     ...versionMetadata,
-                    docs: (0, docs_1.addDocNavigation)(docs, sidebarsUtils, versionMetadata.sidebarFilePath),
+                    docs: (0, docs_1.addDocNavigation)({
+                        docs,
+                        sidebarsUtils,
+                    }),
                     drafts,
                     sidebars,
                 };
@@ -125,81 +141,21 @@ async function pluginContentDocs(context, options) {
             return (0, translations_1.translateLoadedContent)(content, translationFiles);
         },
         async contentLoaded({ content, actions }) {
-            const { loadedVersions } = content;
-            const { docLayoutComponent, docItemComponent, docCategoryGeneratedIndexComponent, breadcrumbs, } = options;
-            const { addRoute, createData, setGlobalData } = actions;
-            const versions = loadedVersions.map((version) => {
-                const sidebarsUtils = (0, utils_2.createSidebarsUtils)(version.sidebars);
-                return {
-                    ...version,
-                    sidebarsUtils,
-                    categoryGeneratedIndices: (0, categoryGeneratedIndex_1.getCategoryGeneratedIndexMetadataList)({
-                        docs: version.docs,
-                        sidebarsUtils,
-                    }),
-                };
-            });
-            async function createVersionTagsRoutes(version) {
-                const versionTags = (0, tags_1.getVersionTags)(version.docs);
-                // TODO tags should be a sub route of the version route
-                async function createTagsListPage() {
-                    const tagsProp = Object.values(versionTags).map((tagValue) => ({
-                        label: tagValue.label,
-                        permalink: tagValue.permalink,
-                        count: tagValue.docIds.length,
-                    }));
-                    // Only create /tags page if there are tags.
-                    if (tagsProp.length > 0) {
-                        const tagsPropPath = await createData(`${(0, utils_1.docuHash)(`tags-list-${version.versionName}-prop`)}.json`, JSON.stringify(tagsProp, null, 2));
-                        addRoute({
-                            path: version.tagsPath,
-                            exact: true,
-                            component: options.docTagsListComponent,
-                            modules: {
-                                tags: aliasedSource(tagsPropPath),
-                            },
-                        });
-                    }
-                }
-                // TODO tags should be a sub route of the version route
-                async function createTagDocListPage(tag) {
-                    const tagProps = (0, props_1.toTagDocListProp)({
-                        allTagsPath: version.tagsPath,
-                        tag,
-                        docs: version.docs,
-                    });
-                    const tagPropPath = await createData(`${(0, utils_1.docuHash)(`tag-${tag.permalink}`)}.json`, JSON.stringify(tagProps, null, 2));
-                    addRoute({
-                        path: tag.permalink,
-                        component: options.docTagDocListComponent,
-                        exact: true,
-                        modules: {
-                            tag: aliasedSource(tagPropPath),
-                        },
-                    });
-                }
-                await createTagsListPage();
-                await Promise.all(Object.values(versionTags).map(createTagDocListPage));
-            }
-            await Promise.all(versions.map((version) => (0, routes_1.createVersionRoutes)({
-                version,
-                docItemComponent,
-                docLayoutComponent,
-                docCategoryGeneratedIndexComponent,
-                pluginId,
-                aliasedSource,
+            const versions = content.loadedVersions.map(versions_1.toFullVersion);
+            await (0, routes_1.createAllRoutes)({
+                baseUrl,
+                versions,
+                options,
                 actions,
-            })));
-            // TODO tags should be a sub route of the version route
-            await Promise.all(versions.map(createVersionTagsRoutes));
-            setGlobalData({
+                aliasedSource,
+            });
+            actions.setGlobalData({
                 path: (0, utils_1.normalizeUrl)([baseUrl, options.routeBasePath]),
                 versions: versions.map(globalData_1.toGlobalDataVersion),
-                breadcrumbs,
+                breadcrumbs: options.breadcrumbs,
             });
         },
         configureWebpack(_config, isServer, utils, content) {
-            const { getJSLoader } = utils;
             const { rehypePlugins, remarkPlugins, beforeDefaultRehypePlugins, beforeDefaultRemarkPlugins, } = options;
             function getSourceToPermalink() {
                 const allDocs = content.loadedVersions.flatMap((v) => v.docs);
@@ -222,7 +178,6 @@ async function pluginContentDocs(context, options) {
                     test: /\.mdx?$/i,
                     include: contentDirs,
                     use: [
-                        getJSLoader({ isServer }),
                         {
                             loader: require.resolve('@docusaurus/mdx-loader'),
                             options: {

package/lib/options.js

@@ -21,7 +21,9 @@ exports.DEFAULT_OPTIONS = {
     exclude: utils_1.GlobExcludeDefault,
     sidebarItemsGenerator: generator_1.DefaultSidebarItemsGenerator,
     numberPrefixParser: numberPrefix_1.DefaultNumberPrefixParser,
-    docLayoutComponent: '@theme/DocPage',
+    docsRootComponent: '@theme/DocsRoot',
+    docVersionRootComponent: '@theme/DocVersionRoot',
+    docRootComponent: '@theme/DocRoot',
     docItemComponent: '@theme/DocItem',
     docTagDocListComponent: '@theme/DocTagDocListPage',
     docTagsListComponent: '@theme/DocTagsListPage',
@@ -59,10 +61,7 @@ const OptionsSchema = utils_validation_1.Joi.object({
     editUrl: utils_validation_1.Joi.alternatives().try(utils_validation_1.URISchema, utils_validation_1.Joi.function()),
     editCurrentVersion: utils_validation_1.Joi.boolean().default(exports.DEFAULT_OPTIONS.editCurrentVersion),
     editLocalizedFiles: utils_validation_1.Joi.boolean().default(exports.DEFAULT_OPTIONS.editLocalizedFiles),
-    routeBasePath: utils_validation_1.Joi.string()
-        // '' not allowed, see https://github.com/facebook/docusaurus/issues/3374
-        // .allow('') ""
-        .default(exports.DEFAULT_OPTIONS.routeBasePath),
+    routeBasePath: utils_validation_1.RouteBasePathSchema.default(exports.DEFAULT_OPTIONS.routeBasePath),
     tagsBasePath: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.tagsBasePath),
     // @ts-expect-error: deprecated
     homePageId: utils_validation_1.Joi.any().forbidden().messages({
@@ -81,7 +80,9 @@ const OptionsSchema = utils_validation_1.Joi.object({
         then: utils_validation_1.Joi.custom((val) => val ? numberPrefix_1.DefaultNumberPrefixParser : numberPrefix_1.DisabledNumberPrefixParser),
     }))
         .default(() => exports.DEFAULT_OPTIONS.numberPrefixParser),
-    docLayoutComponent: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.docLayoutComponent),
+    docsRootComponent: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.docsRootComponent),
+    docVersionRootComponent: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.docVersionRootComponent),
+    docRootComponent: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.docRootComponent),
     docItemComponent: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.docItemComponent),
     docTagsListComponent: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.docTagsListComponent),
     docTagDocListComponent: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.docTagDocListComponent),

package/lib/props.d.ts

@@ -4,8 +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 type { VersionTag } from './types';
-import type { PropSidebars, PropVersionMetadata, PropTagDocList, DocMetadata, LoadedVersion } from '@docusaurus/plugin-content-docs';
+import type { VersionTag, VersionTags } from './types';
+import type { SidebarItemDoc } from './sidebars/types';
+import type { PropSidebars, PropVersionMetadata, PropTagDocList, PropTagsListPage, PropSidebarItemLink, DocMetadata, LoadedVersion } from '@docusaurus/plugin-content-docs';
+export declare function toSidebarDocItemLinkProp({ item, doc, }: {
+    item: SidebarItemDoc;
+    doc: Pick<DocMetadata, 'id' | 'title' | 'permalink' | 'unlisted' | 'frontMatter'>;
+}): PropSidebarItemLink;
 export declare function toSidebarsProp(loadedVersion: LoadedVersion): PropSidebars;
 export declare function toVersionMetadataProp(pluginId: string, loadedVersion: LoadedVersion): PropVersionMetadata;
 export declare function toTagDocListProp({ allTagsPath, tag, docs, }: {
@@ -13,3 +18,4 @@ export declare function toTagDocListProp({ allTagsPath, tag, docs, }: {
     tag: VersionTag;
     docs: DocMetadata[];
 }): PropTagDocList;
+export declare function toTagsListTagsProp(versionTags: VersionTags): PropTagsListPage['tags'];

package/lib/props.js

@@ -6,10 +6,23 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toTagDocListProp = exports.toVersionMetadataProp = exports.toSidebarsProp = void 0;
+exports.toTagsListTagsProp = exports.toTagDocListProp = exports.toVersionMetadataProp = exports.toSidebarsProp = exports.toSidebarDocItemLinkProp = void 0;
 const tslib_1 = require("tslib");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const docs_1 = require("./docs");
+function toSidebarDocItemLinkProp({ item, doc, }) {
+    const { id, title, permalink, frontMatter: { sidebar_label: sidebarLabel, sidebar_custom_props: customProps, }, unlisted, } = doc;
+    return {
+        type: 'link',
+        label: sidebarLabel ?? item.label ?? title,
+        href: permalink,
+        className: item.className,
+        customProps: item.customProps ?? customProps,
+        docId: id,
+        unlisted,
+    };
+}
+exports.toSidebarDocItemLinkProp = toSidebarDocItemLinkProp;
 function toSidebarsProp(loadedVersion) {
     const docsById = (0, docs_1.createDocsByIdIndex)(loadedVersion.docs);
     function getDocById(docId) {
@@ -22,16 +35,8 @@ Available document ids are:
         return docMetadata;
     }
     const convertDocLink = (item) => {
-        const docMetadata = getDocById(item.id);
-        const { title, permalink, frontMatter: { sidebar_label: sidebarLabel }, } = docMetadata;
-        return {
-            type: 'link',
-            label: sidebarLabel ?? item.label ?? title,
-            href: permalink,
-            className: item.className,
-            customProps: item.customProps ?? docMetadata.frontMatter.sidebar_custom_props,
-            docId: docMetadata.unversionedId,
-        };
+        const doc = getDocById(item.id);
+        return toSidebarDocItemLinkProp({ item, doc });
     };
     function getCategoryLinkHref(link) {
         switch (link?.type) {
@@ -43,6 +48,12 @@ Available document ids are:
                 return undefined;
         }
     }
+    function getCategoryLinkUnlisted(link) {
+        if (link?.type === 'doc') {
+            return getDocById(link.id).unlisted;
+        }
+        return false;
+    }
     function getCategoryLinkCustomProps(link) {
         switch (link?.type) {
             case 'doc':
@@ -54,11 +65,13 @@ Available document ids are:
     function convertCategory(item) {
         const { link, ...rest } = item;
         const href = getCategoryLinkHref(link);
+        const linkUnlisted = getCategoryLinkUnlisted(link);
         const customProps = item.customProps ?? getCategoryLinkCustomProps(link);
         return {
             ...rest,
             items: item.items.map(normalizeItem),
             ...(href && { href }),
+            ...(linkUnlisted && { linkUnlisted }),
             ...(customProps && { customProps }),
         };
     }
@@ -82,9 +95,9 @@ Available document ids are:
 exports.toSidebarsProp = toSidebarsProp;
 function toVersionDocsProp(loadedVersion) {
     return Object.fromEntries(loadedVersion.docs.map((doc) => [
-        doc.unversionedId,
+        doc.id,
         {
-            id: doc.unversionedId,
+            id: doc.id,
             title: doc.title,
             description: doc.description,
             sidebar: doc.sidebar,
@@ -124,6 +137,17 @@ function toTagDocListProp({ allTagsPath, tag, docs, }) {
         allTagsPath,
         count: tag.docIds.length,
         items: toDocListProp(),
+        unlisted: tag.unlisted,
     };
 }
 exports.toTagDocListProp = toTagDocListProp;
+function toTagsListTagsProp(versionTags) {
+    return Object.values(versionTags)
+        .filter((tagValue) => !tagValue.unlisted)
+        .map((tagValue) => ({
+        label: tagValue.label,
+        permalink: tagValue.permalink,
+        count: tagValue.docIds.length,
+    }));
+}
+exports.toTagsListTagsProp = toTagsListTagsProp;

package/lib/routes.d.ts

@@ -6,24 +6,17 @@
  */
 import type { PluginContentLoadedActions, RouteConfig } from '@docusaurus/types';
 import type { FullVersion } from './types';
-import type { DocMetadata } from '@docusaurus/plugin-content-docs';
-export declare function createCategoryGeneratedIndexRoutes({ version, actions, docCategoryGeneratedIndexComponent, aliasedSource, }: {
-    version: FullVersion;
+import type { PluginOptions } from '@docusaurus/plugin-content-docs';
+type BuildAllRoutesParam = Omit<CreateAllRoutesParam, 'actions'> & {
+    actions: Omit<PluginContentLoadedActions, 'addRoute' | 'setGlobalData'>;
+};
+export declare function buildAllRoutes(param: BuildAllRoutesParam): Promise<RouteConfig[]>;
+type CreateAllRoutesParam = {
+    baseUrl: string;
+    versions: FullVersion[];
+    options: PluginOptions;
     actions: PluginContentLoadedActions;
-    docCategoryGeneratedIndexComponent: string;
     aliasedSource: (str: string) => string;
-}): Promise<RouteConfig[]>;
-export declare function createDocRoutes({ docs, actions, docItemComponent, }: {
-    docs: DocMetadata[];
-    actions: PluginContentLoadedActions;
-    docItemComponent: string;
-}): Promise<RouteConfig[]>;
-export declare function createVersionRoutes({ version, actions, docItemComponent, docLayoutComponent, docCategoryGeneratedIndexComponent, pluginId, aliasedSource, }: {
-    version: FullVersion;
-    actions: PluginContentLoadedActions;
-    docLayoutComponent: string;
-    docItemComponent: string;
-    docCategoryGeneratedIndexComponent: string;
-    pluginId: string;
-    aliasedSource: (str: string) => string;
-}): Promise<void>;
+};
+export declare function createAllRoutes(param: CreateAllRoutesParam): Promise<void>;
+export {};