@docusaurus/plugin-content-docs 0.0.0-4786 → 0.0.0-4791

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

package/lib/categoryGeneratedIndex.js

@@ -19,8 +19,10 @@ function getCategoryGeneratedIndexMetadata({ category, sidebarsUtils, docsById,
         slug: category.link.slug,
         permalink: category.link.permalink,
         sidebar: sidebarName,
-        previous: (0, utils_1.toNavigationLink)(previous, docsById),
-        next: (0, utils_1.toNavigationLink)(next, docsById),
+        navigation: {
+            previous: (0, utils_1.toNavigationLink)(previous, docsById),
+            next: (0, utils_1.toNavigationLink)(next, docsById),
+        },
     };
 }
 function getCategoryGeneratedIndexMetadataList({ docs, sidebarsUtils, }) {

package/lib/cli.js

@@ -64,7 +64,7 @@ async function cliDocsVersionCommand(version, siteDir, pluginId, options) {
     }
     const { path: docsPath, sidebarPath } = options;
     // Copy docs files.
-    const docsDir = path_1.default.join(siteDir, docsPath);
+    const docsDir = path_1.default.resolve(siteDir, docsPath);
     if ((await fs_extra_1.default.pathExists(docsDir)) &&
         (await fs_extra_1.default.readdir(docsDir)).length > 0) {
         const versionedDir = (0, versions_1.getVersionedDocsDirPath)(siteDir, pluginId);
@@ -72,7 +72,7 @@ async function cliDocsVersionCommand(version, siteDir, pluginId, options) {
         await fs_extra_1.default.copy(docsDir, newVersionDir);
     }
     else {
-        throw new Error(`${pluginIdLogPrefix}: there is no docs to version!`);
+        throw new Error(`${pluginIdLogPrefix}: no docs found in ${docsDir}.`);
     }
     await createVersionedSidebarFile({
         siteDir,

package/lib/docs.d.ts

@@ -5,9 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { LoadContext } from '@docusaurus/types';
-import type { DocFile, DocMetadataBase, VersionMetadata, LoadedVersion } from './types';
+import type { DocFile, LoadedVersion } from './types';
 import type { SidebarsUtils } from './sidebars/utils';
-import type { MetadataOptions, PluginOptions, CategoryIndexMatcher, CategoryIndexMatcherParam } from '@docusaurus/plugin-content-docs';
+import type { MetadataOptions, PluginOptions, CategoryIndexMatcher, DocMetadataBase, VersionMetadata } from '@docusaurus/plugin-content-docs';
 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[]>;
@@ -34,7 +34,7 @@ export declare const isCategoryIndex: CategoryIndexMatcher;
  * `guides/sidebar/autogenerated.md` ->
  *   `'autogenerated', '.md', ['sidebar', 'guides']`
  */
-export declare function toCategoryIndexMatcherParam({ source, sourceDirName, }: Pick<DocMetadataBase, 'source' | 'sourceDirName'>): CategoryIndexMatcherParam;
+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;

package/lib/docs.js

@@ -15,7 +15,6 @@ 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 versions_1 = require("./versions");
 const numberPrefix_1 = require("./numberPrefix");
 const frontMatter_1 = require("./frontMatter");
 const utils_2 = require("./sidebars/utils");
@@ -40,7 +39,7 @@ async function readLastUpdateData(filePath, options) {
     return {};
 }
 async function readDocFile(versionMetadata, source, options) {
-    const contentPath = await (0, utils_1.getFolderContainingFile)((0, versions_1.getDocsDirPaths)(versionMetadata), source);
+    const contentPath = await (0, utils_1.getFolderContainingFile)((0, utils_1.getContentPathList)(versionMetadata), source);
     const filePath = path_1.default.join(contentPath, source);
     const [content, lastUpdate] = await Promise.all([
         fs_extra_1.default.readFile(filePath, 'utf-8'),
@@ -119,7 +118,7 @@ function doProcessDocMetadata({ docFile, versionMetadata, context, options, }) {
     // contentTitle (because it can contain markdown/JSX syntax)
     const title = frontMatter.title ?? contentTitle ?? baseID;
     const description = frontMatter.description ?? excerpt ?? '';
-    const permalink = (0, utils_1.normalizeUrl)([versionMetadata.versionPath, docSlug]);
+    const permalink = (0, utils_1.normalizeUrl)([versionMetadata.path, docSlug]);
     function getDocEditUrl() {
         const relativeFilePath = path_1.default.relative(contentPath, filePath);
         if (typeof options.editUrl === 'function') {
@@ -134,8 +133,8 @@ function doProcessDocMetadata({ docFile, versionMetadata, context, options, }) {
         else if (typeof options.editUrl === 'string') {
             const isLocalized = contentPath === versionMetadata.contentPathLocalized;
             const baseVersionEditUrl = isLocalized && options.editLocalizedFiles
-                ? versionMetadata.versionEditUrlLocalized
-                : versionMetadata.versionEditUrl;
+                ? versionMetadata.editUrlLocalized
+                : versionMetadata.editUrl;
             return (0, utils_1.getEditUrl)(relativeFilePath, baseVersionEditUrl);
         }
         return undefined;

package/lib/frontMatter.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 { DocFrontMatter } from './types';
+import type { DocFrontMatter } from '@docusaurus/plugin-content-docs';
 export declare function validateDocFrontMatter(frontMatter: {
     [key: string]: unknown;
 }): DocFrontMatter;

package/lib/globalData.js

@@ -44,9 +44,9 @@ function toGlobalSidebars(sidebars, version) {
 function toGlobalDataVersion(version) {
     return {
         name: version.versionName,
-        label: version.versionLabel,
+        label: version.label,
         isLast: version.isLast,
-        path: version.versionPath,
+        path: version.path,
         mainDocId: version.mainDocId,
         docs: version.docs
             .map(toGlobalDataDoc)

package/lib/index.js

@@ -62,7 +62,7 @@ async function pluginContentDocs(context, options) {
         getPathsToWatch() {
             function getVersionPathsToWatch(version) {
                 const result = [
-                    ...options.include.flatMap((pattern) => (0, versions_1.getDocsDirPaths)(version).map((docsDirPath) => `${docsDirPath}/${pattern}`)),
+                    ...options.include.flatMap((pattern) => (0, utils_1.getContentPathList)(version).map((docsDirPath) => `${docsDirPath}/${pattern}`)),
                     `${version.contentPath}/**/${generator_1.CategoryMetadataFilenamePattern}`,
                 ];
                 if (typeof version.sidebarFilePath === 'string') {
@@ -138,7 +138,7 @@ async function pluginContentDocs(context, options) {
                 // TODO tags should be a sub route of the version route
                 async function createTagsListPage() {
                     const tagsProp = Object.values(versionTags).map((tagValue) => ({
-                        name: tagValue.name,
+                        name: tagValue.label,
                         permalink: tagValue.permalink,
                         count: tagValue.docIds.length,
                     }));
@@ -211,7 +211,7 @@ async function pluginContentDocs(context, options) {
                 },
             };
             function createMDXLoaderRule() {
-                const contentDirs = versionsMetadata.flatMap(versions_1.getDocsDirPaths);
+                const contentDirs = versionsMetadata.flatMap(utils_1.getContentPathList);
                 return {
                     test: /\.mdx?$/i,
                     include: contentDirs

package/lib/markdown/linkify.js

@@ -7,10 +7,9 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.linkify = void 0;
-const versions_1 = require("../versions");
 const utils_1 = require("@docusaurus/utils");
 function getVersion(filePath, options) {
-    const versionFound = options.versionsMetadata.find((version) => (0, versions_1.getDocsDirPaths)(version).some((docsDirPath) => filePath.startsWith(docsDirPath)));
+    const versionFound = options.versionsMetadata.find((version) => (0, utils_1.getContentPathList)(version).some((docsDirPath) => filePath.startsWith(docsDirPath)));
     // At this point, this should never happen, because the MDX loaders' paths are
     // literally using the version content paths; but if we allow sourcing content
     // from outside the docs directory (through the `include` option, for example;

package/lib/props.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 { LoadedVersion, VersionTag, DocMetadata } from './types';
-import type { PropSidebars, PropVersionMetadata, PropTagDocList } from '@docusaurus/plugin-content-docs';
+import type { LoadedVersion, VersionTag } from './types';
+import type { PropSidebars, PropVersionMetadata, PropTagDocList, DocMetadata } from '@docusaurus/plugin-content-docs';
 export declare function toSidebarsProp(loadedVersion: LoadedVersion): PropSidebars;
 export declare function toVersionMetadataProp(pluginId: string, loadedVersion: LoadedVersion): PropVersionMetadata;
 export declare function toTagDocListProp({ allTagsPath, tag, docs, }: {

package/lib/props.js

@@ -81,10 +81,10 @@ function toVersionMetadataProp(pluginId, loadedVersion) {
     return {
         pluginId,
         version: loadedVersion.versionName,
-        label: loadedVersion.versionLabel,
-        banner: loadedVersion.versionBanner,
-        badge: loadedVersion.versionBadge,
-        className: loadedVersion.versionClassName,
+        label: loadedVersion.label,
+        banner: loadedVersion.banner,
+        badge: loadedVersion.badge,
+        className: loadedVersion.className,
         isLast: loadedVersion.isLast,
         docsSidebars: toSidebarsProp(loadedVersion),
         docs: toVersionDocsProp(loadedVersion),
@@ -104,7 +104,7 @@ function toTagDocListProp({ allTagsPath, tag, docs, }) {
         }));
     }
     return {
-        name: tag.name,
+        name: tag.label,
         permalink: tag.permalink,
         docs: toDocListProp(),
         allTagsPath,

package/lib/routes.d.ts

@@ -5,7 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { PluginContentLoadedActions, RouteConfig } from '@docusaurus/types';
-import type { DocMetadata, LoadedVersion } from './types';
+import type { LoadedVersion } from './types';
+import type { DocMetadata } from '@docusaurus/plugin-content-docs';
 export declare function createCategoryGeneratedIndexRoutes({ version, actions, docCategoryGeneratedIndexComponent, aliasedSource, }: {
     version: LoadedVersion;
     actions: PluginContentLoadedActions;

package/lib/routes.js

@@ -14,23 +14,11 @@ 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) {
-        const { sidebar, title, description, slug, permalink, previous, next, image, keywords, } = categoryGeneratedIndex;
-        const propFileName = slugs.slug(`${version.versionPath}-${categoryGeneratedIndex.sidebar}-category-${categoryGeneratedIndex.title}`);
-        const prop = {
-            title,
-            description,
-            slug,
-            permalink,
-            image,
-            keywords,
-            navigation: {
-                previous,
-                next,
-            },
-        };
+        const { sidebar, ...prop } = categoryGeneratedIndex;
+        const propFileName = slugs.slug(`${version.path}-${categoryGeneratedIndex.sidebar}-category-${categoryGeneratedIndex.title}`);
         const propData = await actions.createData(`${(0, utils_1.docuHash)(`category/${propFileName}`)}.json`, JSON.stringify(prop, null, 2));
         return {
-            path: permalink,
+            path: categoryGeneratedIndex.permalink,
             component: docCategoryGeneratedIndexComponent,
             exact: true,
             modules: {
@@ -86,7 +74,7 @@ async function createVersionRoutes({ loadedVersion, actions, docItemComponent, d
             return routes.sort((a, b) => a.path.localeCompare(b.path));
         }
         actions.addRoute({
-            path: version.versionPath,
+            path: version.path,
             // allow matching /docs/* as well
             exact: false,
             // main docs component (DocPage)

package/lib/sidebars/generator.js

@@ -104,7 +104,7 @@ Available doc IDs:
             };
         }
         function createCategoryItem(dir, fullPath, folderName) {
-            const categoryMetadata = categoriesMetadata[(0, utils_1.posixPath)(path_1.default.join(autogenDir, fullPath))];
+            const categoryMetadata = categoriesMetadata[path_1.default.posix.join(autogenDir, fullPath)];
             const allItems = Object.entries(dir).map(([key, content]) => dirToItem(content, key, `${fullPath}/${key}`));
             // Try to match a doc inside the category folder,
             // using the "local id" (myDoc) or "qualified id" (dirName/myDoc)

package/lib/sidebars/postProcessor.js

@@ -15,7 +15,7 @@ function normalizeCategoryLink(category, params) {
         // default slug logic can be improved
         const getDefaultSlug = () => `/category/${params.categoryLabelSlugger.slug(category.label)}`;
         const slug = category.link.slug ?? getDefaultSlug();
-        const permalink = (0, utils_1.normalizeUrl)([params.version.versionPath, slug]);
+        const permalink = (0, utils_1.normalizeUrl)([params.version.path, slug]);
         return {
             ...category.link,
             slug,

package/lib/sidebars/types.d.ts

@@ -5,8 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { Optional, Required } from 'utility-types';
-import type { DocMetadataBase, VersionMetadata } from '../types';
-import type { NumberPrefixParser, SidebarOptions, CategoryIndexMatcher } from '@docusaurus/plugin-content-docs';
+import type { NumberPrefixParser, SidebarOptions, CategoryIndexMatcher, DocMetadataBase, VersionMetadata } from '@docusaurus/plugin-content-docs';
 import type { Slugger } from '@docusaurus/utils';
 declare type Expand<T extends {
     [x: string]: unknown;
@@ -126,15 +125,6 @@ export declare type PropSidebars = {
     [sidebarId: string]: PropSidebar;
 };
 export declare type PropSidebarBreadcrumbsItem = PropSidebarItemLink | PropSidebarItemCategory;
-export declare type PropVersionDoc = {
-    id: string;
-    title: string;
-    description?: string;
-    sidebar?: string;
-};
-export declare type PropVersionDocs = {
-    [docId: string]: PropVersionDoc;
-};
 export declare type CategoryMetadataFile = {
     label?: string;
     position?: number;
@@ -149,17 +139,30 @@ export declare type CategoryMetadataFile = {
 export declare type SidebarItemsGeneratorDoc = Pick<DocMetadataBase, 'id' | 'unversionedId' | 'title' | 'frontMatter' | 'source' | 'sourceDirName' | 'sidebarPosition'>;
 export declare type SidebarItemsGeneratorVersion = Pick<VersionMetadata, 'versionName' | 'contentPath'>;
 export declare type SidebarItemsGeneratorArgs = {
+    /** The sidebar item with type "autogenerated" to be transformed. */
     item: SidebarItemAutogenerated;
+    /** Useful metadata for the version this sidebar belongs to. */
     version: SidebarItemsGeneratorVersion;
+    /** All the docs of that version (unfiltered). */
     docs: SidebarItemsGeneratorDoc[];
+    /** Number prefix parser configured for this plugin. */
     numberPrefixParser: NumberPrefixParser;
+    /** The default category index matcher which you can override. */
     isCategoryIndex: CategoryIndexMatcher;
+    /**
+     * key is the path relative to the doc content directory, value is the
+     * category metadata file's content.
+     */
     categoriesMetadata: {
         [filePath: string]: CategoryMetadataFile;
     };
 };
 export declare type SidebarItemsGenerator = (generatorArgs: SidebarItemsGeneratorArgs) => Promise<NormalizedSidebar>;
 export declare type SidebarItemsGeneratorOptionArgs = {
+    /**
+     * Useful to re-use/enhance the default sidebar generation logic from
+     * Docusaurus.
+     */
     defaultSidebarItemsGenerator: SidebarItemsGenerator;
 } & SidebarItemsGeneratorArgs;
 export declare type SidebarItemsGeneratorOption = (generatorArgs: SidebarItemsGeneratorOptionArgs) => Promise<NormalizedSidebarItem[]>;

package/lib/sidebars/utils.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { Sidebars, Sidebar, SidebarItem, SidebarItemCategory, SidebarItemLink, SidebarItemDoc, SidebarCategoriesShorthand, SidebarItemConfig, SidebarItemCategoryWithGeneratedIndex, SidebarNavigationItem } from './types';
-import type { DocMetadataBase, DocNavLink } from '../types';
+import type { DocMetadataBase, PropNavigationLink } from '@docusaurus/plugin-content-docs';
 export declare function isCategoriesShorthand(item: SidebarItemConfig): item is SidebarCategoriesShorthand;
 export declare function transformSidebarItems(sidebar: Sidebar, updateFn: (item: SidebarItem) => SidebarItem): Sidebar;
 export declare function collectSidebarDocItems(sidebar: Sidebar): SidebarItemDoc[];
@@ -48,7 +48,7 @@ export declare type SidebarsUtils = {
     checkSidebarsDocIds: (validDocIds: string[], sidebarFilePath: string) => void;
 };
 export declare function createSidebarsUtils(sidebars: Sidebars): SidebarsUtils;
-export declare function toDocNavigationLink(doc: DocMetadataBase): DocNavLink;
+export declare function toDocNavigationLink(doc: DocMetadataBase): PropNavigationLink;
 export declare function toNavigationLink(navigationItem: SidebarNavigationItem | undefined, docsById: {
     [docId: string]: DocMetadataBase;
-}): DocNavLink | undefined;
+}): PropNavigationLink | undefined;

package/lib/slug.d.ts

@@ -4,8 +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 { DocMetadataBase } from './types';
-import type { NumberPrefixParser } from '@docusaurus/plugin-content-docs';
+import type { NumberPrefixParser, DocMetadataBase } from '@docusaurus/plugin-content-docs';
 export default function getSlug({ baseID, frontMatterSlug, source, sourceDirName, stripDirNumberPrefixes, numberPrefixParser, }: {
     baseID: string;
     frontMatterSlug?: string;

package/lib/tags.d.ts

@@ -4,5 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { VersionTags, DocMetadata } from './types';
+import type { VersionTags } from './types';
+import type { DocMetadata } from '@docusaurus/plugin-content-docs';
 export declare function getVersionTags(docs: DocMetadata[]): VersionTags;

package/lib/tags.js

@@ -13,7 +13,7 @@ const lodash_1 = tslib_1.__importDefault(require("lodash"));
 function getVersionTags(docs) {
     const groups = (0, utils_1.groupTaggedItems)(docs, (doc) => doc.tags);
     return lodash_1.default.mapValues(groups, (group) => ({
-        name: group.tag.label,
+        label: group.tag.label,
         docIds: group.items.map((item) => item.id),
         permalink: group.tag.permalink,
     }));

package/lib/translations.js

@@ -174,7 +174,7 @@ function translateSidebars(version, sidebarsTranslations) {
 function getVersionTranslationFiles(version) {
     const versionTranslations = {
         'version.label': {
-            message: version.versionLabel,
+            message: version.label,
             description: `The label for version ${version.versionName}`,
         },
     };
@@ -196,7 +196,7 @@ function translateVersion(version, translationFiles) {
     const versionTranslations = translationFiles[getVersionFileName(version.versionName)].content;
     return {
         ...version,
-        versionLabel: versionTranslations['version.label']?.message ?? version.versionLabel,
+        label: versionTranslations['version.label']?.message ?? version.label,
         sidebars: translateSidebars(version, versionTranslations),
         // docs: translateDocs(version.docs, versionTranslations),
     };

package/lib/types.d.ts

@@ -5,8 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { Sidebars } from './sidebars/types';
-import type { Tag, FrontMatterTag, BrokenMarkdownLink, ContentPaths } from '@docusaurus/utils';
-import type { VersionBanner } from '@docusaurus/plugin-content-docs';
+import type { BrokenMarkdownLink, Tag } from '@docusaurus/utils';
+import type { VersionMetadata, LastUpdateData, DocMetadata, CategoryGeneratedIndexMetadata } from '@docusaurus/plugin-content-docs';
 export declare type DocFile = {
     contentPath: string;
     filePath: string;
@@ -14,100 +14,17 @@ export declare type DocFile = {
     content: string;
     lastUpdate: LastUpdateData;
 };
-export declare type VersionMetadata = ContentPaths & {
-    versionName: string;
-    versionLabel: string;
-    versionPath: string;
-    tagsPath: string;
-    versionEditUrl?: string | undefined;
-    versionEditUrlLocalized?: string | undefined;
-    versionBanner: VersionBanner | null;
-    versionBadge: boolean;
-    versionClassName: string;
-    isLast: boolean;
-    sidebarFilePath: string | false | undefined;
-    routePriority: number | undefined;
-};
-export declare type LastUpdateData = {
-    lastUpdatedAt?: number;
-    formattedLastUpdatedAt?: string;
-    lastUpdatedBy?: string;
-};
-export declare type DocFrontMatter = {
-    id?: string;
-    title?: string;
-    tags?: FrontMatterTag[];
-    hide_title?: boolean;
-    hide_table_of_contents?: boolean;
-    keywords?: string[];
-    image?: string;
-    description?: string;
-    slug?: string;
-    sidebar_label?: string;
-    sidebar_position?: number;
-    sidebar_class_name?: string;
-    sidebar_custom_props?: {
-        [key: string]: unknown;
-    };
-    displayed_sidebar?: string | null;
-    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 & {
-    id: string;
-    unversionedId: string;
-    version: string;
-    title: string;
-    description: string;
-    source: string;
-    sourceDirName: string;
-    slug: string;
-    permalink: string;
-    sidebarPosition?: number;
-    editUrl?: string | null;
-    tags: Tag[];
-    frontMatter: DocFrontMatter & {
-        [key: string]: unknown;
-    };
-};
-export declare type DocNavLink = {
-    title: string;
-    permalink: string;
-};
-export declare type DocMetadata = DocMetadataBase & {
-    sidebar?: string;
-    previous?: DocNavLink;
-    next?: DocNavLink;
-};
-export declare type CategoryGeneratedIndexMetadata = {
-    title: string;
-    description?: string;
-    slug: string;
-    permalink: string;
-    sidebar: string;
-    previous?: DocNavLink;
-    next?: DocNavLink;
-    image?: string;
-    keywords?: string | readonly string[];
-};
 export declare type SourceToPermalink = {
     [source: string]: string;
 };
-export declare type VersionTag = {
-    name: string;
+export declare type VersionTag = Tag & {
+    /** all doc ids having this tag. */
     docIds: string[];
-    permalink: string;
 };
 export declare type VersionTags = {
     [key: string]: VersionTag;
 };
 export declare type LoadedVersion = VersionMetadata & {
-    versionPath: string;
     mainDocId: string;
     docs: DocMetadata[];
     sidebars: Sidebars;

package/lib/versions.d.ts

@@ -4,8 +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 { VersionMetadata } from './types';
-import type { PluginOptions, VersionBanner } from '@docusaurus/plugin-content-docs';
+import type { PluginOptions, VersionBanner, VersionMetadata } from '@docusaurus/plugin-content-docs';
 import type { LoadContext } from '@docusaurus/types';
 export declare function getVersionedDocsDirPath(siteDir: string, pluginId: string): string;
 export declare function getVersionedSidebarsDirPath(siteDir: string, pluginId: string): string;
@@ -38,4 +37,3 @@ export declare function readVersionsMetadata({ context, options, }: {
     context: Pick<LoadContext, 'siteDir' | 'baseUrl' | 'i18n'>;
     options: Pick<PluginOptions, 'id' | 'path' | 'sidebarPath' | 'routeBasePath' | 'tagsBasePath' | 'includeCurrentVersion' | 'disableVersioning' | 'lastVersion' | 'versions' | 'onlyIncludeVersions' | 'editUrl' | 'editCurrentVersion'>;
 }): Promise<VersionMetadata[]>;
-export declare function getDocsDirPaths(versionMetadata: Pick<VersionMetadata, 'contentPath' | 'contentPathLocalized'>): [string, string];

package/lib/versions.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDocsDirPaths = exports.readVersionsMetadata = exports.filterVersions = exports.getVersionBadge = exports.getVersionBanner = exports.getDefaultVersionBanner = exports.readVersionNames = exports.readVersionsFile = exports.getVersionsFilePath = exports.getVersionedSidebarsDirPath = exports.getVersionedDocsDirPath = void 0;
+exports.readVersionsMetadata = exports.filterVersions = exports.getVersionBadge = exports.getVersionBanner = exports.getDefaultVersionBanner = exports.readVersionNames = exports.readVersionsFile = exports.getVersionsFilePath = exports.getVersionedSidebarsDirPath = exports.getVersionedDocsDirPath = 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"));
@@ -110,14 +110,11 @@ function getVersionMetadataPaths({ versionName, context, options, }) {
         sidebarFilePath: path_1.default.join(getVersionedSidebarsDirPath(context.siteDir, options.id), `version-${versionName}-sidebars.json`),
     };
 }
-function getVersionEditUrls({ contentPath, contentPathLocalized, context: { siteDir, i18n }, options: { id, path: currentVersionPath, editUrl, editCurrentVersion }, }) {
-    if (!editUrl) {
-        return undefined;
-    }
-    // if the user is using the functional form of editUrl,
-    // he has total freedom and we can't compute a "version edit url"
-    if (typeof editUrl === 'function') {
-        return undefined;
+function getVersionEditUrls({ contentPath, contentPathLocalized, context: { siteDir, i18n }, options: { id, path: currentVersionPath, editUrl: editUrlOption, editCurrentVersion, }, }) {
+    // If the user is using the functional form of editUrl,
+    // she has total freedom and we can't compute a "version edit url"
+    if (!editUrlOption || typeof editUrlOption === 'function') {
+        return { editUrl: undefined, editUrlLocalized: undefined };
     }
     const editDirPath = editCurrentVersion ? currentVersionPath : contentPath;
     const editDirPathLocalized = editCurrentVersion
@@ -130,14 +127,14 @@ function getVersionEditUrls({ contentPath, contentPathLocalized, context: { site
         : contentPathLocalized;
     const versionPathSegment = (0, utils_1.posixPath)(path_1.default.relative(siteDir, path_1.default.resolve(siteDir, editDirPath)));
     const versionPathSegmentLocalized = (0, utils_1.posixPath)(path_1.default.relative(siteDir, path_1.default.resolve(siteDir, editDirPathLocalized)));
-    const versionEditUrl = (0, utils_1.normalizeUrl)([editUrl, versionPathSegment]);
-    const versionEditUrlLocalized = (0, utils_1.normalizeUrl)([
-        editUrl,
+    const editUrl = (0, utils_1.normalizeUrl)([editUrlOption, versionPathSegment]);
+    const editUrlLocalized = (0, utils_1.normalizeUrl)([
+        editUrlOption,
         versionPathSegmentLocalized,
     ]);
     return {
-        versionEditUrl,
-        versionEditUrlLocalized,
+        editUrl,
+        editUrlLocalized,
     };
 }
 function getDefaultVersionBanner({ versionName, versionNames, lastVersionName, }) {
@@ -192,9 +189,9 @@ function createVersionMetadata({ versionName, versionNames, lastVersionName, con
     }
     const defaultVersionPathPart = getDefaultVersionPathPart();
     const versionOptions = options.versions[versionName] ?? {};
-    const versionLabel = versionOptions.label ?? defaultVersionLabel;
+    const label = versionOptions.label ?? defaultVersionLabel;
     const versionPathPart = versionOptions.path ?? defaultVersionPathPart;
-    const versionPath = (0, utils_1.normalizeUrl)([
+    const routePath = (0, utils_1.normalizeUrl)([
         context.baseUrl,
         options.routeBasePath,
         versionPathPart,
@@ -205,26 +202,25 @@ function createVersionMetadata({ versionName, versionNames, lastVersionName, con
         context,
         options,
     });
-    // 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 = (0, utils_1.normalizeUrl)([versionPath, options.tagsBasePath]);
+    const tagsPath = (0, utils_1.normalizeUrl)([routePath, options.tagsBasePath]);
     return {
         versionName,
-        versionLabel,
-        versionPath,
+        label,
+        path: routePath,
         tagsPath,
-        versionEditUrl: versionEditUrls?.versionEditUrl,
-        versionEditUrlLocalized: versionEditUrls?.versionEditUrlLocalized,
-        versionBanner: getVersionBanner({
+        editUrl: versionEditUrls.editUrl,
+        editUrlLocalized: versionEditUrls.editUrlLocalized,
+        banner: getVersionBanner({
             versionName,
             versionNames,
             lastVersionName,
             options,
         }),
-        versionBadge: getVersionBadge({ versionName, versionNames, options }),
-        versionClassName: getVersionClassName({ versionName, options }),
+        badge: getVersionBadge({ versionName, versionNames, options }),
+        className: getVersionClassName({ versionName, options }),
         isLast,
         routePriority,
         sidebarFilePath,
@@ -315,10 +311,3 @@ async function readVersionsMetadata({ context, options, }) {
     return versionsMetadata;
 }
 exports.readVersionsMetadata = readVersionsMetadata;
-// order matter!
-// Read in priority the localized path, then the unlocalized one
-// We want the localized doc to "override" the unlocalized one
-function getDocsDirPaths(versionMetadata) {
-    return [versionMetadata.contentPathLocalized, versionMetadata.contentPath];
-}
-exports.getDocsDirPaths = getDocsDirPaths;