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

package/lib/docs.d.ts

@@ -5,14 +5,16 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { LoadContext } from '@docusaurus/types';
-import { DocFile, DocMetadataBase, MetadataOptions, PluginOptions, VersionMetadata } from './types';
+import { DocFile, DocMetadataBase, MetadataOptions, PluginOptions, VersionMetadata, LoadedVersion } from './types';
+import type { Sidebars } from './sidebars/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' | 'showLastUpdateAuthor' | 'showLastUpdateTime'>): Promise<DocFile[]>;
+export declare function readVersionDocs(versionMetadata: VersionMetadata, options: Pick<PluginOptions, 'include' | 'exclude' | 'showLastUpdateAuthor' | 'showLastUpdateTime'>): Promise<DocFile[]>;
 export declare function processDocMetadata(args: {
     docFile: DocFile;
     versionMetadata: VersionMetadata;
     context: LoadContext;
     options: MetadataOptions;
 }): DocMetadataBase;
+export declare function handleNavigation(docsBase: DocMetadataBase[], sidebars: Sidebars, sidebarFilePath: string): Pick<LoadedVersion, 'mainDocId' | 'docs'>;
 export {};

package/lib/docs.js

@@ -6,25 +6,26 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.processDocMetadata = exports.readVersionDocs = exports.readDocFile = void 0;
+exports.handleNavigation = 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 path_1 = (0, tslib_1.__importDefault)(require("path"));
+const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
+const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const lodash_1 = require("lodash");
 const utils_1 = require("@docusaurus/utils");
 const lastUpdate_1 = require("./lastUpdate");
-const slug_1 = tslib_1.__importDefault(require("./slug"));
+const slug_1 = (0, tslib_1.__importDefault)(require("./slug"));
 const constants_1 = require("./constants");
-const globby_1 = tslib_1.__importDefault(require("globby"));
 const versions_1 = require("./versions");
 const numberPrefix_1 = require("./numberPrefix");
 const docFrontMatter_1 = require("./docFrontMatter");
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const utils_2 = require("./sidebars/utils");
 async function readLastUpdateData(filePath, options) {
     const { showLastUpdateAuthor, showLastUpdateTime } = options;
     if (showLastUpdateAuthor || showLastUpdateTime) {
         // Use fake data in dev for faster development.
         const fileLastUpdateData = process.env.NODE_ENV === 'production'
-            ? await lastUpdate_1.getFileLastUpdate(filePath)
+            ? await (0, lastUpdate_1.getFileLastUpdate)(filePath)
             : {
                 author: 'Author',
                 timestamp: 1539502055,
@@ -40,7 +41,7 @@ async function readLastUpdateData(filePath, options) {
     return {};
 }
 async function readDocFile(versionMetadata, source, options) {
-    const contentPath = await utils_1.getFolderContainingFile(versions_1.getDocsDirPaths(versionMetadata), source);
+    const contentPath = await (0, utils_1.getFolderContainingFile)((0, versions_1.getDocsDirPaths)(versionMetadata), source);
     const filePath = path_1.default.join(contentPath, source);
     const [content, lastUpdate] = await Promise.all([
         fs_extra_1.default.readFile(filePath, 'utf-8'),
@@ -50,8 +51,9 @@ async function readDocFile(versionMetadata, source, options) {
 }
 exports.readDocFile = readDocFile;
 async function readVersionDocs(versionMetadata, options) {
-    const sources = await globby_1.default(options.include, {
+    const sources = await (0, utils_1.Globby)(options.include, {
         cwd: versionMetadata.contentPath,
+        ignore: options.exclude,
     });
     return Promise.all(sources.map((source) => readDocFile(versionMetadata, source, options)));
 }
@@ -61,19 +63,19 @@ function doProcessDocMetadata({ docFile, versionMetadata, context, options, }) {
     const { source, content, lastUpdate, contentPath, filePath } = docFile;
     const { homePageId } = options;
     const { siteDir, i18n } = context;
-    const { frontMatter: unsafeFrontMatter, contentTitle, excerpt, } = utils_1.parseMarkdownString(content);
-    const frontMatter = docFrontMatter_1.validateDocFrontMatter(unsafeFrontMatter);
+    const { frontMatter: unsafeFrontMatter, contentTitle, excerpt, } = (0, utils_1.parseMarkdownString)(content);
+    const frontMatter = (0, docFrontMatter_1.validateDocFrontMatter)(unsafeFrontMatter);
     const { custom_edit_url: customEditURL, 
     // Strip number prefixes by default (01-MyFolder/01-MyDoc.md => MyFolder/MyDoc) by default,
-    // but allow to disable this behavior with frontmatterr
-    parse_number_prefixes = true, } = frontMatter;
+    // but allow to disable this behavior with frontmatter
+    parse_number_prefixes: parseNumberPrefixes = true, } = frontMatter;
     // ex: api/plugins/myDoc -> myDoc
     // ex: myDoc -> myDoc
     const sourceFileNameWithoutExtension = path_1.default.basename(source, path_1.default.extname(source));
     // ex: api/plugins/myDoc -> api/plugins
     // ex: myDoc -> .
     const sourceDirName = path_1.default.dirname(source);
-    const { filename: unprefixedFileName, numberPrefix } = parse_number_prefixes
+    const { filename: unprefixedFileName, numberPrefix } = parseNumberPrefixes
         ? options.numberPrefixParser(sourceFileNameWithoutExtension)
         : { filename: sourceFileNameWithoutExtension, numberPrefix: undefined };
     const baseID = (_a = frontMatter.id) !== null && _a !== void 0 ? _a : unprefixedFileName;
@@ -95,8 +97,8 @@ function doProcessDocMetadata({ docFile, versionMetadata, context, options, }) {
             return undefined;
         }
         // Eventually remove the number prefixes from intermediate directories
-        return parse_number_prefixes
-            ? numberPrefix_1.stripPathNumberPrefixes(sourceDirName, options.numberPrefixParser)
+        return parseNumberPrefixes
+            ? (0, numberPrefix_1.stripPathNumberPrefixes)(sourceDirName, options.numberPrefixParser)
             : sourceDirName;
     }
     const unversionedId = [computeDirNameIdPrefix(), baseID]
@@ -112,25 +114,25 @@ function doProcessDocMetadata({ docFile, versionMetadata, context, options, }) {
     }
     const docSlug = isDocsHomePage
         ? '/'
-        : slug_1.default({
+        : (0, slug_1.default)({
             baseID,
             dirName: sourceDirName,
             frontmatterSlug: frontMatter.slug,
-            stripDirNumberPrefixes: parse_number_prefixes,
+            stripDirNumberPrefixes: parseNumberPrefixes,
             numberPrefixParser: options.numberPrefixParser,
         });
     // Note: the title is used by default for page title, sidebar label, pagination buttons...
     // frontMatter.title should be used in priority over contentTitle (because it can contain markdown/JSX syntax)
     const title = (_d = (_c = frontMatter.title) !== null && _c !== void 0 ? _c : contentTitle) !== null && _d !== void 0 ? _d : baseID;
     const description = (_f = (_e = frontMatter.description) !== null && _e !== void 0 ? _e : excerpt) !== null && _f !== void 0 ? _f : '';
-    const permalink = utils_1.normalizeUrl([versionMetadata.versionPath, docSlug]);
+    const permalink = (0, utils_1.normalizeUrl)([versionMetadata.versionPath, docSlug]);
     function getDocEditUrl() {
         const relativeFilePath = path_1.default.relative(contentPath, filePath);
         if (typeof options.editUrl === 'function') {
             return options.editUrl({
                 version: versionMetadata.versionName,
-                versionDocsDirPath: utils_1.posixPath(path_1.default.relative(siteDir, versionMetadata.contentPath)),
-                docPath: utils_1.posixPath(relativeFilePath),
+                versionDocsDirPath: (0, utils_1.posixPath)(path_1.default.relative(siteDir, versionMetadata.contentPath)),
+                docPath: (0, utils_1.posixPath)(relativeFilePath),
                 permalink,
                 locale: context.i18n.currentLocale,
             });
@@ -140,7 +142,7 @@ function doProcessDocMetadata({ docFile, versionMetadata, context, options, }) {
             const baseVersionEditUrl = isLocalized && options.editLocalizedFiles
                 ? versionMetadata.versionEditUrlLocalized
                 : versionMetadata.versionEditUrl;
-            return utils_1.getEditUrl(relativeFilePath, baseVersionEditUrl);
+            return (0, utils_1.getEditUrl)(relativeFilePath, baseVersionEditUrl);
         }
         else {
             return undefined;
@@ -156,11 +158,12 @@ function doProcessDocMetadata({ docFile, versionMetadata, context, options, }) {
         isDocsHomePage,
         title,
         description,
-        source: utils_1.aliasedSitePath(filePath, siteDir),
+        source: (0, utils_1.aliasedSitePath)(filePath, siteDir),
         sourceDirName,
         slug: docSlug,
         permalink,
         editUrl: customEditURL !== undefined ? customEditURL : getDocEditUrl(),
+        tags: (0, utils_1.normalizeFrontMatterTags)(versionMetadata.tagsPath, frontMatter.tags),
         version: versionMetadata.versionName,
         lastUpdatedBy: lastUpdate.lastUpdatedBy,
         lastUpdatedAt: lastUpdate.lastUpdatedAt,
@@ -181,3 +184,54 @@ function processDocMetadata(args) {
     }
 }
 exports.processDocMetadata = processDocMetadata;
+function handleNavigation(docsBase, sidebars, sidebarFilePath) {
+    const docsBaseById = (0, lodash_1.keyBy)(docsBase, (doc) => doc.id);
+    const { checkSidebarsDocIds, getDocNavigation, getFirstDocIdOfFirstSidebar } = (0, utils_2.createSidebarsUtils)(sidebars);
+    const validDocIds = Object.keys(docsBaseById);
+    checkSidebarsDocIds(validDocIds, sidebarFilePath);
+    // Add sidebar/next/previous to the docs
+    function addNavData(doc) {
+        const { sidebarName, previousId, nextId } = getDocNavigation(doc.id);
+        const toDocNavLink = (docId, type) => {
+            var _a;
+            if (!docId) {
+                return undefined;
+            }
+            if (!docsBaseById[docId]) {
+                // 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}.`);
+            }
+            const { title, permalink, frontMatter: { pagination_label: paginationLabel, sidebar_label: sidebarLabel, }, } = docsBaseById[docId];
+            return { title: (_a = paginationLabel !== null && paginationLabel !== void 0 ? paginationLabel : sidebarLabel) !== null && _a !== void 0 ? _a : title, permalink };
+        };
+        const { frontMatter: { pagination_next: paginationNext = nextId, pagination_prev: paginationPrev = previousId, }, } = doc;
+        const previous = toDocNavLink(paginationPrev, 'prev');
+        const next = toDocNavLink(paginationNext, 'next');
+        return { ...doc, sidebar: sidebarName, previous, next };
+    }
+    const docs = docsBase.map(addNavData);
+    // sort to ensure consistent output for tests
+    docs.sort((a, b) => a.id.localeCompare(b.id));
+    /**
+     * The "main doc" is the "version entry point"
+     * We browse this doc by clicking on a version:
+     * - the "home" doc (at '/docs/')
+     * - the first doc of the first sidebar
+     * - a random doc (if no docs are in any sidebar... edge case)
+     */
+    function getMainDoc() {
+        const versionHomeDoc = docs.find((doc) => doc.slug === '/');
+        const firstDocIdOfFirstSidebar = getFirstDocIdOfFirstSidebar();
+        if (versionHomeDoc) {
+            return versionHomeDoc;
+        }
+        else if (firstDocIdOfFirstSidebar) {
+            return docs.find((doc) => doc.id === firstDocIdOfFirstSidebar);
+        }
+        else {
+            return docs[0];
+        }
+    }
+    return { mainDocId: getMainDoc().unversionedId, docs };
+}
+exports.handleNavigation = handleNavigation;

package/lib/index.js

@@ -8,10 +8,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateOptions = void 0;
 const tslib_1 = require("tslib");
-const path_1 = tslib_1.__importDefault(require("path"));
+const path_1 = (0, tslib_1.__importDefault)(require("path"));
 const constants_1 = require("@docusaurus/core/lib/constants");
 const utils_1 = require("@docusaurus/utils");
 const sidebars_1 = require("./sidebars");
+const generator_1 = require("./sidebars/generator");
 const docs_1 = require("./docs");
 const versions_1 = require("./versions");
 const cli_1 = require("./cli");
@@ -20,17 +21,16 @@ const lodash_1 = require("lodash");
 const globalData_1 = require("./globalData");
 const props_1 = require("./props");
 const translations_1 = require("./translations");
-const sidebarItemsGenerator_1 = require("./sidebarItemsGenerator");
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const tags_1 = require("./tags");
 function pluginContentDocs(context, options) {
     var _a;
     const { siteDir, generatedFilesDir, baseUrl, siteConfig } = context;
-    const versionsMetadata = versions_1.readVersionsMetadata({ context, options });
-    const sourceToPermalink = {};
+    const versionsMetadata = (0, versions_1.readVersionsMetadata)({ context, options });
     const pluginId = (_a = options.id) !== null && _a !== void 0 ? _a : constants_1.DEFAULT_PLUGIN_ID;
     const pluginDataDirRoot = path_1.default.join(generatedFilesDir, 'docusaurus-plugin-content-docs');
     const dataDir = path_1.default.join(pluginDataDirRoot, pluginId);
-    const aliasedSource = (source) => `~docs/${utils_1.posixPath(path_1.default.relative(pluginDataDirRoot, source))}`;
+    const aliasedSource = (source) => `~docs/${(0, utils_1.posixPath)(path_1.default.relative(pluginDataDirRoot, source))}`;
     return {
         name: 'docusaurus-plugin-content-docs',
         getThemePath() {
@@ -54,43 +54,38 @@ function pluginContentDocs(context, options) {
                 .arguments('<version>')
                 .description(commandDescription)
                 .action((version) => {
-                cli_1.cliDocsVersionCommand(version, siteDir, pluginId, {
+                (0, cli_1.cliDocsVersionCommand)(version, siteDir, pluginId, {
                     path: options.path,
                     sidebarPath: options.sidebarPath,
+                    sidebarCollapsed: options.sidebarCollapsed,
+                    sidebarCollapsible: options.sidebarCollapsible,
                 });
             });
         },
         async getTranslationFiles({ content }) {
-            return translations_1.getLoadedContentTranslationFiles(content);
-        },
-        getClientModules() {
-            const modules = [];
-            if (options.admonitions) {
-                modules.push(require.resolve('remark-admonitions/styles/infima.css'));
-            }
-            return modules;
+            return (0, translations_1.getLoadedContentTranslationFiles)(content);
         },
         getPathsToWatch() {
             function getVersionPathsToWatch(version) {
                 const result = [
-                    ...lodash_1.flatten(options.include.map((pattern) => versions_1.getDocsDirPaths(version).map((docsDirPath) => `${docsDirPath}/${pattern}`))),
-                    `${version.contentPath}/**/${sidebarItemsGenerator_1.CategoryMetadataFilenamePattern}`,
+                    ...options.include.flatMap((pattern) => (0, versions_1.getDocsDirPaths)(version).map((docsDirPath) => `${docsDirPath}/${pattern}`)),
+                    `${version.contentPath}/**/${generator_1.CategoryMetadataFilenamePattern}`,
                 ];
                 if (typeof version.sidebarFilePath === 'string') {
                     result.unshift(version.sidebarFilePath);
                 }
                 return result;
             }
-            return lodash_1.flatten(versionsMetadata.map(getVersionPathsToWatch));
+            return versionsMetadata.flatMap(getVersionPathsToWatch);
         },
         async loadContent() {
             async function loadVersionDocsBase(versionMetadata) {
-                const docFiles = await docs_1.readVersionDocs(versionMetadata, options);
+                const docFiles = await (0, docs_1.readVersionDocs)(versionMetadata, 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) {
-                    return docs_1.processDocMetadata({
+                    return (0, docs_1.processDocMetadata)({
                         docFile,
                         versionMetadata,
                         context,
@@ -100,76 +95,21 @@ function pluginContentDocs(context, options) {
                 return Promise.all(docFiles.map(processVersionDoc));
             }
             async function doLoadVersion(versionMetadata) {
-                const unprocessedSidebars = sidebars_1.loadSidebars(versionMetadata.sidebarFilePath);
                 const docsBase = await loadVersionDocsBase(versionMetadata);
-                const docsBaseById = lodash_1.keyBy(docsBase, (doc) => doc.id);
-                const sidebars = await sidebars_1.processSidebars({
+                const sidebars = await (0, sidebars_1.loadSidebars)(versionMetadata.sidebarFilePath, {
                     sidebarItemsGenerator: options.sidebarItemsGenerator,
                     numberPrefixParser: options.numberPrefixParser,
-                    unprocessedSidebars,
                     docs: docsBase,
                     version: versionMetadata,
+                    options: {
+                        sidebarCollapsed: options.sidebarCollapsed,
+                        sidebarCollapsible: options.sidebarCollapsible,
+                    },
                 });
-                const sidebarsUtils = sidebars_1.createSidebarsUtils(sidebars);
-                const validDocIds = Object.keys(docsBaseById);
-                sidebarsUtils.checkSidebarsDocIds(validDocIds, versionMetadata.sidebarFilePath);
-                // Add sidebar/next/previous to the docs
-                function addNavData(doc) {
-                    const { sidebarName, previousId, nextId, } = sidebarsUtils.getDocNavigation(doc.id);
-                    const toDocNavLink = (navDocId) => {
-                        var _a, _b;
-                        const { title, permalink, frontMatter } = docsBaseById[navDocId];
-                        return {
-                            title: (_b = (_a = frontMatter.pagination_label) !== null && _a !== void 0 ? _a : frontMatter.sidebar_label) !== null && _b !== void 0 ? _b : title,
-                            permalink,
-                        };
-                    };
-                    return {
-                        ...doc,
-                        sidebar: sidebarName,
-                        previous: previousId ? toDocNavLink(previousId) : undefined,
-                        next: nextId ? toDocNavLink(nextId) : undefined,
-                    };
-                }
-                const docs = docsBase.map(addNavData);
-                // sort to ensure consistent output for tests
-                docs.sort((a, b) => a.id.localeCompare(b.id));
-                // TODO annoying side effect!
-                Object.values(docs).forEach((loadedDoc) => {
-                    const { source, permalink } = loadedDoc;
-                    sourceToPermalink[source] = permalink;
-                });
-                // TODO really useful? replace with global state logic?
-                const permalinkToSidebar = {};
-                Object.values(docs).forEach((doc) => {
-                    if (doc.sidebar) {
-                        permalinkToSidebar[doc.permalink] = doc.sidebar;
-                    }
-                });
-                // The "main doc" is the "version entry point"
-                // We browse this doc by clicking on a version:
-                // - the "home" doc (at '/docs/')
-                // - the first doc of the first sidebar
-                // - a random doc (if no docs are in any sidebar... edge case)
-                function getMainDoc() {
-                    const versionHomeDoc = docs.find((doc) => doc.unversionedId === options.homePageId || doc.slug === '/');
-                    const firstDocIdOfFirstSidebar = sidebarsUtils.getFirstDocIdOfFirstSidebar();
-                    if (versionHomeDoc) {
-                        return versionHomeDoc;
-                    }
-                    else if (firstDocIdOfFirstSidebar) {
-                        return docs.find((doc) => doc.id === firstDocIdOfFirstSidebar);
-                    }
-                    else {
-                        return docs[0];
-                    }
-                }
                 return {
                     ...versionMetadata,
-                    mainDocId: getMainDoc().unversionedId,
+                    ...(0, docs_1.handleNavigation)(docsBase, sidebars, versionMetadata.sidebarFilePath),
                     sidebars,
-                    permalinkToSidebar,
-                    docs: docs.map(addNavData),
                 };
             }
             async function loadVersion(versionMetadata) {
@@ -186,7 +126,7 @@ function pluginContentDocs(context, options) {
             };
         },
         translateContent({ content, translationFiles }) {
-            return translations_1.translateLoadedContent(content, translationFiles);
+            return (0, translations_1.translateLoadedContent)(content, translationFiles);
         },
         async contentLoaded({ content, actions }) {
             const { loadedVersions } = content;
@@ -197,20 +137,68 @@ function pluginContentDocs(context, options) {
                     await createData(
                     // Note that this created data path must be in sync with
                     // metadataPath provided to mdx-loader.
-                    `${utils_1.docuHash(metadataItem.source)}.json`, JSON.stringify(metadataItem, null, 2));
-                    return {
+                    `${(0, utils_1.docuHash)(metadataItem.source)}.json`, JSON.stringify(metadataItem, null, 2));
+                    const docRoute = {
                         path: metadataItem.permalink,
                         component: docItemComponent,
                         exact: true,
                         modules: {
                             content: metadataItem.source,
                         },
+                        // Because the parent (DocPage) comp need to access it easily
+                        // This permits to render the sidebar once without unmount/remount when navigating (and preserve sidebar state)
+                        ...(metadataItem.sidebar && {
+                            sidebar: metadataItem.sidebar,
+                        }),
                     };
+                    return docRoute;
                 }));
                 return routes.sort((a, b) => a.path.localeCompare(b.path));
             };
+            async function createVersionTagsRoutes(loadedVersion) {
+                const versionTags = (0, tags_1.getVersionTags)(loadedVersion.docs);
+                async function createTagsListPage() {
+                    const tagsProp = Object.values(versionTags).map((tagValue) => ({
+                        name: tagValue.name,
+                        permalink: tagValue.permalink,
+                        count: tagValue.docIds.length,
+                    }));
+                    // Only create /tags page if there are tags.
+                    if (Object.keys(tagsProp).length > 0) {
+                        const tagsPropPath = await createData(`${(0, utils_1.docuHash)(`tags-list-${loadedVersion.versionName}-prop`)}.json`, JSON.stringify(tagsProp, null, 2));
+                        addRoute({
+                            path: loadedVersion.tagsPath,
+                            exact: true,
+                            component: options.docTagsListComponent,
+                            modules: {
+                                tags: aliasedSource(tagsPropPath),
+                            },
+                        });
+                    }
+                }
+                async function createTagDocListPage(tag) {
+                    const tagProps = (0, props_1.toTagDocListProp)({
+                        allTagsPath: loadedVersion.tagsPath,
+                        tag,
+                        docs: loadedVersion.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));
+            }
             async function doCreateVersionRoutes(loadedVersion) {
-                const versionMetadataPropPath = await createData(`${utils_1.docuHash(`version-${loadedVersion.versionName}-metadata-prop`)}.json`, JSON.stringify(props_1.toVersionMetadataProp(pluginId, loadedVersion), null, 2));
+                await createVersionTagsRoutes(loadedVersion);
+                const versionMetadata = (0, props_1.toVersionMetadataProp)(pluginId, loadedVersion);
+                const versionMetadataPropPath = await createData(`${(0, utils_1.docuHash)(`version-${loadedVersion.versionName}-metadata-prop`)}.json`, JSON.stringify(versionMetadata, null, 2));
                 addRoute({
                     path: loadedVersion.versionPath,
                     // allow matching /docs/* as well
@@ -236,31 +224,36 @@ function pluginContentDocs(context, options) {
             }
             await Promise.all(loadedVersions.map(createVersionRoutes));
             setGlobalData({
-                path: utils_1.normalizeUrl([baseUrl, options.routeBasePath]),
+                path: (0, utils_1.normalizeUrl)([baseUrl, options.routeBasePath]),
                 versions: loadedVersions.map(globalData_1.toGlobalDataVersion),
             });
         },
-        configureWebpack(_config, isServer, utils) {
+        configureWebpack(_config, isServer, utils, content) {
             const { getJSLoader } = utils;
             const { rehypePlugins, remarkPlugins, beforeDefaultRehypePlugins, beforeDefaultRemarkPlugins, } = options;
+            function getSourceToPermalink() {
+                const allDocs = content.loadedVersions.flatMap((v) => v.docs);
+                return (0, lodash_1.mapValues)((0, lodash_1.keyBy)(allDocs, (d) => d.source), (d) => d.permalink);
+            }
             const docsMarkdownOptions = {
                 siteDir,
-                sourceToPermalink,
+                sourceToPermalink: getSourceToPermalink(),
                 versionsMetadata,
                 onBrokenMarkdownLink: (brokenMarkdownLink) => {
                     if (siteConfig.onBrokenMarkdownLinks === 'ignore') {
                         return;
                     }
-                    utils_1.reportMessage(`Docs markdown link couldn't be resolved: (${brokenMarkdownLink.link}) in ${brokenMarkdownLink.filePath} for version ${brokenMarkdownLink.contentPaths.versionName}`, siteConfig.onBrokenMarkdownLinks);
+                    (0, utils_1.reportMessage)(`Docs markdown link couldn't be resolved: (${brokenMarkdownLink.link}) in ${brokenMarkdownLink.filePath} for version ${brokenMarkdownLink.contentPaths.versionName}`, siteConfig.onBrokenMarkdownLinks);
                 },
             };
             function createMDXLoaderRule() {
+                const contentDirs = versionsMetadata.flatMap(versions_1.getDocsDirPaths);
                 return {
                     test: /(\.mdx?)$/,
-                    include: lodash_1.flatten(versionsMetadata.map(versions_1.getDocsDirPaths))
+                    include: contentDirs
                         // Trailing slash is important, see https://github.com/facebook/docusaurus/pull/3970
                         .map(utils_1.addTrailingPathSeparator),
-                    use: lodash_1.compact([
+                    use: [
                         getJSLoader({ isServer }),
                         {
                             loader: require.resolve('@docusaurus/mdx-loader'),
@@ -270,11 +263,12 @@ function pluginContentDocs(context, options) {
                                 beforeDefaultRehypePlugins,
                                 beforeDefaultRemarkPlugins,
                                 staticDir: path_1.default.join(siteDir, constants_1.STATIC_DIR_NAME),
+                                isMDXPartial: (0, utils_1.createAbsoluteFilePathMatcher)(options.exclude, contentDirs),
                                 metadataPath: (mdxPath) => {
                                     // Note that metadataPath must be the same/in-sync as
                                     // the path from createData for each MDX.
-                                    const aliasedPath = utils_1.aliasedSitePath(mdxPath, siteDir);
-                                    return path_1.default.join(dataDir, `${utils_1.docuHash(aliasedPath)}.json`);
+                                    const aliasedPath = (0, utils_1.aliasedSitePath)(mdxPath, siteDir);
+                                    return path_1.default.join(dataDir, `${(0, utils_1.docuHash)(aliasedPath)}.json`);
                                 },
                             },
                         },
@@ -282,7 +276,7 @@ function pluginContentDocs(context, options) {
                             loader: path_1.default.resolve(__dirname, './markdown/index.js'),
                             options: docsMarkdownOptions,
                         },
-                    ]),
+                    ].filter(Boolean),
                 };
             }
             return {

package/lib/lastUpdate.js

@@ -8,8 +8,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getFileLastUpdate = void 0;
 const tslib_1 = require("tslib");
-const shelljs_1 = tslib_1.__importDefault(require("shelljs"));
-const execa_1 = tslib_1.__importDefault(require("execa"));
+const shelljs_1 = (0, tslib_1.__importDefault)(require("shelljs"));
+const execa_1 = (0, tslib_1.__importDefault)(require("execa"));
+const path_1 = (0, tslib_1.__importDefault)(require("path"));
 const GIT_COMMIT_TIMESTAMP_AUTHOR_REGEX = /^(\d+), (.+)$/;
 let showedGitRequirementError = false;
 async function getFileLastUpdate(filePath) {
@@ -35,12 +36,11 @@ async function getFileLastUpdate(filePath) {
             }
             return null;
         }
-        const { stdout } = await execa_1.default('git', [
-            'log',
-            '-1',
-            '--format=%ct, %an',
-            filePath,
-        ]);
+        const fileBasename = path_1.default.basename(filePath);
+        const fileDirname = path_1.default.dirname(filePath);
+        const { stdout } = await (0, execa_1.default)('git', ['log', '-1', '--format=%ct, %an', fileBasename], {
+            cwd: fileDirname,
+        });
         return getTimestampAndAuthor(stdout);
     }
     catch (error) {

package/lib/markdown/index.d.ts

@@ -4,9 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-/// <reference types="node" />
-interface Loader extends Function {
-    (this: any, source: string): string | Buffer | void | undefined;
-}
-declare const markdownLoader: Loader;
-export default markdownLoader;
+import { DocsMarkdownOption } from '../types';
+import type { LoaderContext } from 'webpack';
+export default function markdownLoader(this: LoaderContext<DocsMarkdownOption>, source: string): void;

package/lib/markdown/index.js

@@ -7,10 +7,10 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 const linkify_1 = require("./linkify");
-const markdownLoader = function (source) {
+function markdownLoader(source) {
     const fileString = source;
     const callback = this.async();
     const options = this.getOptions();
-    return (callback && callback(null, linkify_1.linkify(fileString, this.resourcePath, options)));
-};
+    return (callback && callback(null, (0, linkify_1.linkify)(fileString, this.resourcePath, options)));
+}
 exports.default = markdownLoader;

package/lib/markdown/linkify.js

@@ -10,7 +10,7 @@ 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) => versions_1.getDocsDirPaths(version).some((docsDirPath) => filePath.startsWith(docsDirPath)));
+    const versionFound = options.versionsMetadata.find((version) => (0, versions_1.getDocsDirPaths)(version).some((docsDirPath) => filePath.startsWith(docsDirPath)));
     if (!versionFound) {
         throw new Error(`Unexpected error: Markdown file at "${filePath}" does not belong to any docs version!`);
     }
@@ -18,7 +18,7 @@ function getVersion(filePath, options) {
 }
 function linkify(fileString, filePath, options) {
     const { siteDir, sourceToPermalink, onBrokenMarkdownLink } = options;
-    const { newContent, brokenMarkdownLinks } = utils_1.replaceMarkdownLinks({
+    const { newContent, brokenMarkdownLinks } = (0, utils_1.replaceMarkdownLinks)({
         siteDir,
         fileString,
         filePath,

package/lib/options.d.ts

@@ -9,4 +9,4 @@ import { Joi } from '@docusaurus/utils-validation';
 import { OptionValidationContext, ValidationResult } from '@docusaurus/types';
 export declare const DEFAULT_OPTIONS: Omit<PluginOptions, 'id' | 'sidebarPath'>;
 export declare const OptionsSchema: Joi.ObjectSchema<any>;
-export declare function validateOptions({ validate, options, }: OptionValidationContext<PluginOptions>): ValidationResult<PluginOptions>;
+export declare function validateOptions({ validate, options: userOptions, }: OptionValidationContext<PluginOptions>): ValidationResult<PluginOptions>;