@docusaurus/core 3.2.1 → 3.3.0

package/bin/docusaurus.mjs

@@ -115,6 +115,10 @@ cli
     '--skip-build',
     'skip building website before deploy it (default: false)',
   )
+  .option(
+    '--target-dir <dir>',
+    'path to the target directory to deploy to (default: `.`)',
+  )
   .action(deploy);
 
 /**

package/lib/client/App.d.ts

@@ -4,6 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+/// <reference types="@docusaurus/module-type-aliases" />
 /// <reference types="react" />
 import '@generated/client-modules';
 export default function App(): JSX.Element;

package/lib/client/App.js

@@ -21,9 +21,15 @@ import SiteMetadataDefaults from './SiteMetadataDefaults';
 // eslint-disable-next-line import/order
 import ErrorBoundary from '@docusaurus/ErrorBoundary';
 import HasHydratedDataAttribute from './hasHydratedDataAttribute';
-export default function App() {
-    const routeElement = renderRoutes(routes);
+const routesElement = renderRoutes(routes);
+function AppNavigation() {
     const location = useLocation();
+    const normalizedLocation = normalizeLocation(location);
+    return (<PendingNavigation location={normalizedLocation}>
+      {routesElement}
+    </PendingNavigation>);
+}
+export default function App() {
     return (<ErrorBoundary>
       <DocusaurusContextProvider>
         <BrowserContextProvider>
@@ -31,9 +37,7 @@ export default function App() {
             <SiteMetadataDefaults />
             <SiteMetadata />
             <BaseUrlIssueBanner />
-            <PendingNavigation location={normalizeLocation(location)}>
-              {routeElement}
-            </PendingNavigation>
+            <AppNavigation />
           </Root>
           <HasHydratedDataAttribute />
         </BrowserContextProvider>

package/lib/client/exports/ComponentCreator.js

@@ -100,10 +100,12 @@ export default function ComponentCreator(path, hash) {
             delete loadedModules.__comp;
             const routeContext = loadedModules.__context;
             delete loadedModules.__context;
+            const routeProps = loadedModules.__props;
+            delete loadedModules.__props;
             /* eslint-enable no-underscore-dangle */
             // Is there any way to put this RouteContextProvider upper in the tree?
             return (<RouteContextProvider value={routeContext}>
-          <Component {...loadedModules} {...props}/>
+          <Component {...loadedModules} {...routeProps} {...props}/>
         </RouteContextProvider>);
         },
     });

package/lib/commands/deploy.d.ts

@@ -7,5 +7,6 @@
 import { type LoadContextParams } from '../server/site';
 export type DeployCLIOptions = Pick<LoadContextParams, 'config' | 'locale' | 'outDir'> & {
     skipBuild?: boolean;
+    targetDir?: string;
 };
 export declare function deploy(siteDirParam?: string, cliOptions?: Partial<DeployCLIOptions>): Promise<void>;

package/lib/commands/deploy.js

@@ -128,26 +128,25 @@ You can also set the deploymentBranch property in docusaurus.config.js .`);
     // out to deployment branch.
     const currentCommit = shellExecLog('git rev-parse HEAD').stdout.trim();
     const runDeploy = async (outputDirectory) => {
+        const targetDirectory = cliOptions.targetDir ?? '.';
         const fromPath = outputDirectory;
         const toPath = await fs_extra_1.default.mkdtemp(path_1.default.join(os_1.default.tmpdir(), `${projectName}-${deploymentBranch}`));
         shelljs_1.default.cd(toPath);
-        // Check out deployment branch when cloning repository, and then remove all
-        // the files in the directory. If the 'clone' command fails, assume that
-        // the deployment branch doesn't exist, and initialize git in an empty
-        // directory, check out a clean deployment branch and add remote.
-        if (shellExecLog(`git clone --depth 1 --branch ${deploymentBranch} ${deploymentRepoURL} "${toPath}"`).code === 0) {
-            shellExecLog('git rm -rf .');
-        }
-        else {
-            shellExecLog('git init');
+        // Clones the repo into the temp folder and checks out the target branch.
+        // If the branch doesn't exist, it creates a new one based on the
+        // repository default branch.
+        if (shellExecLog(`git clone --depth 1 --branch ${deploymentBranch} ${deploymentRepoURL} "${toPath}"`).code !== 0) {
+            shellExecLog(`git clone --depth 1 ${deploymentRepoURL} "${toPath}"`);
             shellExecLog(`git checkout -b ${deploymentBranch}`);
-            shellExecLog(`git remote add origin ${deploymentRepoURL}`);
         }
+        // Clear out any existing contents in the target directory
+        shellExecLog(`git rm -rf ${targetDirectory}`);
+        const targetPath = path_1.default.join(toPath, targetDirectory);
         try {
-            await fs_extra_1.default.copy(fromPath, toPath);
+            await fs_extra_1.default.copy(fromPath, targetPath);
         }
         catch (err) {
-            logger_1.default.error `Copying build assets from path=${fromPath} to path=${toPath} failed.`;
+            logger_1.default.error `Copying build assets from path=${fromPath} to path=${targetPath} failed.`;
             throw err;
         }
         shellExecLog('git add --all');
@@ -184,7 +183,8 @@ You can also set the deploymentBranch property in docusaurus.config.js .`);
     if (!cliOptions.skipBuild) {
         // Build site, then push to deploymentBranch branch of specified repo.
         try {
-            await (0, build_1.build)(siteDir, cliOptions, false).then(() => runDeploy(outDir));
+            await (0, build_1.build)(siteDir, cliOptions, false);
+            await runDeploy(outDir);
         }
         catch (err) {
             logger_1.default.error('Deployment of the build output failed.');

package/lib/commands/serve.js

@@ -15,9 +15,16 @@ const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const utils_1 = require("@docusaurus/utils");
 const serve_handler_1 = tslib_1.__importDefault(require("serve-handler"));
 const openBrowser_1 = tslib_1.__importDefault(require("react-dev-utils/openBrowser"));
+const utils_common_1 = require("@docusaurus/utils-common");
 const config_1 = require("../server/config");
 const build_1 = require("./build");
 const getHostPort_1 = require("../server/getHostPort");
+function redirect(res, location) {
+    res.writeHead(302, {
+        Location: location,
+    });
+    res.end();
+}
 async function serve(siteDirParam = '.', cliOptions = {}) {
     const siteDir = await fs_extra_1.default.realpath(siteDirParam);
     const buildDir = cliOptions.dir ?? utils_1.DEFAULT_BUILD_DIR_NAME;
@@ -40,14 +47,22 @@ async function serve(siteDirParam = '.', cliOptions = {}) {
     const server = http_1.default.createServer((req, res) => {
         // Automatically redirect requests to /baseUrl/
         if (!req.url?.startsWith(baseUrl)) {
-            res.writeHead(302, {
-                Location: baseUrl,
-            });
-            res.end();
+            redirect(res, baseUrl);
+            return;
+        }
+        // We do the redirect ourselves for a good reason
+        // server-handler is annoying and won't include /baseUrl/ in redirects
+        const normalizedUrl = (0, utils_common_1.applyTrailingSlash)(req.url, { trailingSlash, baseUrl });
+        if (req.url !== normalizedUrl) {
+            redirect(res, normalizedUrl);
             return;
         }
         // Remove baseUrl before calling serveHandler, because /baseUrl/ should
         // serve /build/index.html, not /build/baseUrl/index.html (does not exist)
+        // Note server-handler is really annoying here:
+        // - no easy way to do rewrites such as "/baseUrl/:path" => "/:path"
+        // - no easy way to "reapply" the baseUrl to the redirect "Location" header
+        // See also https://github.com/facebook/docusaurus/pull/10090
         req.url = req.url.replace(baseUrl, '/');
         (0, serve_handler_1.default)(req, res, {
             cleanUrls: true,

package/lib/server/codegen/codegen.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 { CodeTranslations, DocusaurusConfig, GlobalData, I18n, RouteConfig, SiteMetadata } from '@docusaurus/types';
+import type { CodeTranslations, DocusaurusConfig, GlobalData, I18n, PluginRouteConfig, SiteMetadata } from '@docusaurus/types';
 type CodegenParams = {
     generatedFilesDir: string;
     siteConfig: DocusaurusConfig;
@@ -14,7 +14,7 @@ type CodegenParams = {
     i18n: I18n;
     codeTranslations: CodeTranslations;
     siteMetadata: SiteMetadata;
-    routes: RouteConfig[];
+    routes: PluginRouteConfig[];
 };
 export declare function generateSiteFiles(params: CodegenParams): Promise<void>;
 export {};

package/lib/server/codegen/codegenRoutes.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 { RouteConfig, RouteChunkNames } from '@docusaurus/types';
+import type { RouteConfig, RouteChunkNames, PluginRouteConfig } from '@docusaurus/types';
 type RoutesCode = {
     /** Serialized routes config that can be directly emitted into temp file. */
     routesConfig: string;
@@ -42,8 +42,8 @@ export declare function genChunkName(modulePath: string, prefix?: string, prefer
 export declare function generateRoutesCode(routeConfigs: RouteConfig[]): RoutesCode;
 type GenerateRouteFilesParams = {
     generatedFilesDir: string;
-    routes: RouteConfig[];
+    routes: PluginRouteConfig[];
     baseUrl: string;
 };
-export declare function generateRouteFiles({ generatedFilesDir, routes, }: GenerateRouteFilesParams): Promise<void>;
+export declare function generateRouteFiles({ generatedFilesDir, routes: initialRoutes, }: GenerateRouteFilesParams): Promise<void>;
 export {};

package/lib/server/codegen/codegenRoutes.js

@@ -9,6 +9,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateRouteFiles = exports.generateRoutesCode = exports.genChunkName = void 0;
 const tslib_1 = require("tslib");
 const querystring_1 = tslib_1.__importDefault(require("querystring"));
+const path_1 = tslib_1.__importDefault(require("path"));
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const utils_1 = require("@docusaurus/utils");
 /** Indents every line of `str` by one level. */
@@ -58,7 +59,7 @@ exports.genChunkName = genChunkName;
  * is the same as react-router's `RouteConfig`. Formatting is similar to
  * `JSON.stringify` but without all the quotes.
  */
-function serializeRouteConfig({ routePath, routeHash, exact, subroutesCodeStrings, props, }) {
+function serializeRouteConfig({ routePath, routeHash, exact, subroutesCodeStrings, attributes, }) {
     const parts = [
         `path: '${routePath}'`,
         `component: ComponentCreator('${routePath}', '${routeHash}')`,
@@ -71,10 +72,10 @@ function serializeRouteConfig({ routePath, routeHash, exact, subroutesCodeString
 ${indent(subroutesCodeStrings.join(',\n'))}
 ]`);
     }
-    Object.entries(props).forEach(([propName, propValue]) => {
-        const isIdentifier = /^[$_\p{ID_Start}][$\u200c\u200d\p{ID_Continue}]*$/u.test(propName);
-        const key = isIdentifier ? propName : JSON.stringify(propName);
-        parts.push(`${key}: ${JSON.stringify(propValue)}`);
+    Object.entries(attributes).forEach(([attrName, attrValue]) => {
+        const isIdentifier = /^[$_\p{ID_Start}][$\u200c\u200d\p{ID_Continue}]*$/u.test(attrName);
+        const key = isIdentifier ? attrName : JSON.stringify(attrName);
+        parts.push(`${key}: ${JSON.stringify(attrValue)}`);
     });
     return `{
 ${indent(parts.join(',\n'))}
@@ -114,7 +115,7 @@ function genChunkNames(routeModule, prefix, name, res) {
  * `routesPaths`, and `routesChunkNames` accordingly.
  */
 function genRouteCode(routeConfig, res) {
-    const { path: routePath, component, modules = {}, context, routes: subroutes, priority, exact, metadata, ...props } = routeConfig;
+    const { path: routePath, component, modules = {}, context, routes: subroutes, priority, exact, metadata, props, plugin, ...attributes } = routeConfig;
     if (typeof routePath !== 'string' || !component) {
         throw new Error(`Invalid route config: path must be a string and component is required.
 ${JSON.stringify(routeConfig)}`);
@@ -132,7 +133,7 @@ ${JSON.stringify(routeConfig)}`);
         routeHash,
         subroutesCodeStrings: subroutes?.map((r) => genRouteCode(r, res)),
         exact,
-        props,
+        attributes,
     });
 }
 /**
@@ -179,7 +180,75 @@ ${Object.entries(registry)
 `);
 const genRoutesChunkNames = ({ generatedFilesDir, routesChunkNames, }) => (0, utils_1.generate)(generatedFilesDir, 'routesChunkNames.json', JSON.stringify(routesChunkNames, null, 2));
 const genRoutes = ({ generatedFilesDir, routesConfig, }) => (0, utils_1.generate)(generatedFilesDir, 'routes.js', routesConfig);
-async function generateRouteFiles({ generatedFilesDir, routes, }) {
+async function generateRoutePropModule({ generatedFilesDir, route, plugin, }) {
+    ensureNoPropsConflict(route);
+    const moduleContent = JSON.stringify(route.props);
+    // TODO we should aim to reduce this path length
+    // This adds bytes to the global module registry
+    const relativePath = path_1.default.posix.join(plugin.name, plugin.id, 'p', `${(0, utils_1.docuHash)(route.path)}.json`);
+    const modulePath = path_1.default.posix.join(generatedFilesDir, relativePath);
+    const aliasedPath = path_1.default.posix.join('@generated', relativePath);
+    await (0, utils_1.generate)(generatedFilesDir, modulePath, moduleContent);
+    return aliasedPath;
+}
+function ensureNoPropsConflict(route) {
+    if (!route.props && !route.modules) {
+        return;
+    }
+    const conflictingPropNames = lodash_1.default.intersection(Object.keys(route.props ?? {}), Object.keys(route.modules ?? {}));
+    if (conflictingPropNames.length > 0) {
+        throw new Error(`Route ${route.path} has conflicting props declared using both route.modules and route.props APIs for keys: ${conflictingPropNames.join(', ')}\nThis is not permitted, otherwise one prop would override the over.`);
+    }
+}
+async function preprocessRouteProps({ generatedFilesDir, route, plugin, }) {
+    const propsModulePathPromise = route.props
+        ? generateRoutePropModule({
+            generatedFilesDir,
+            route,
+            plugin,
+        })
+        : undefined;
+    const subRoutesPromise = route.routes
+        ? Promise.all(route.routes.map((subRoute) => {
+            return preprocessRouteProps({
+                generatedFilesDir,
+                route: subRoute,
+                plugin,
+            });
+        }))
+        : undefined;
+    const [propsModulePath, subRoutes] = await Promise.all([
+        propsModulePathPromise,
+        subRoutesPromise,
+    ]);
+    const newRoute = {
+        ...route,
+        modules: {
+            ...route.modules,
+            ...(propsModulePath && { __props: propsModulePath }),
+        },
+        routes: subRoutes,
+        props: undefined,
+    };
+    return newRoute;
+}
+// For convenience, it's possible to pass a "route.props" object
+// This method converts the props object to a regular module
+// and assigns it to route.modules.__props attribute
+async function preprocessAllPluginsRoutesProps({ generatedFilesDir, routes, }) {
+    return Promise.all(routes.map((route) => {
+        return preprocessRouteProps({
+            generatedFilesDir,
+            route,
+            plugin: route.plugin,
+        });
+    }));
+}
+async function generateRouteFiles({ generatedFilesDir, routes: initialRoutes, }) {
+    const routes = await preprocessAllPluginsRoutesProps({
+        generatedFilesDir,
+        routes: initialRoutes,
+    });
     const { registry, routesChunkNames, routesConfig } = generateRoutesCode(routes);
     await Promise.all([
         genRegistry({ generatedFilesDir, registry }),

package/lib/server/configValidation.js

@@ -18,7 +18,7 @@ exports.DEFAULT_I18N_CONFIG = {
     localeConfigs: {},
 };
 exports.DEFAULT_MARKDOWN_CONFIG = {
-    format: 'mdx',
+    format: 'mdx', // TODO change this to "detect" in Docusaurus v4?
     mermaid: false,
     preprocessor: undefined,
     parseFrontMatter: utils_1.DEFAULT_PARSE_FRONT_MATTER,
@@ -27,12 +27,15 @@ exports.DEFAULT_MARKDOWN_CONFIG = {
         admonitions: true,
         headingIds: true,
     },
+    anchors: {
+        maintainCase: false,
+    },
     remarkRehypeOptions: undefined,
 };
 exports.DEFAULT_CONFIG = {
     i18n: exports.DEFAULT_I18N_CONFIG,
     onBrokenLinks: 'throw',
-    onBrokenAnchors: 'warn',
+    onBrokenAnchors: 'warn', // TODO Docusaurus v4: change to throw
     onBrokenMarkdownLinks: 'warn',
     onDuplicateRoutes: 'warn',
     plugins: [],
@@ -147,7 +150,7 @@ exports.ConfigSchema = utils_validation_1.Joi.object({
     favicon: utils_validation_1.Joi.string().optional(),
     title: utils_validation_1.Joi.string().required(),
     url: SiteUrlSchema,
-    trailingSlash: utils_validation_1.Joi.boolean(),
+    trailingSlash: utils_validation_1.Joi.boolean(), // No default value! undefined = retrocompatible legacy behavior!
     i18n: I18N_CONFIG_SCHEMA,
     onBrokenLinks: utils_validation_1.Joi.string()
         .equal('ignore', 'log', 'warn', 'throw')
@@ -238,6 +241,9 @@ exports.ConfigSchema = utils_validation_1.Joi.object({
         // Not sure if it's a good idea, validation is likely to become stale
         // See https://github.com/remarkjs/remark-rehype#options
         utils_validation_1.Joi.object().unknown(),
+        anchors: utils_validation_1.Joi.object({
+            maintainCase: utils_validation_1.Joi.boolean().default(exports.DEFAULT_CONFIG.markdown.anchors.maintainCase),
+        }).default(exports.DEFAULT_CONFIG.markdown.anchors),
     }).default(exports.DEFAULT_CONFIG.markdown),
 }).messages({
     'docusaurus.configValidationWarning': 'Docusaurus config validation warning. Field {#label}: {#warningMessage}',

package/lib/server/plugins/actions.js

@@ -18,13 +18,20 @@ const routeConfig_1 = require("./routeConfig");
 async function createPluginActionsUtils({ plugin, generatedFilesDir, baseUrl, trailingSlash, }) {
     const pluginId = plugin.options.id;
     // Plugins data files are namespaced by pluginName/pluginId
+    // TODO Docusaurus v4 breaking change
+    //  module aliasing should be automatic
+    //  we should never find local absolute FS paths in the codegen registry
+    const aliasedSource = (source) => `@generated/${(0, utils_1.posixPath)(path_1.default.relative(generatedFilesDir, source))}`;
+    // TODO use @generated data dir here!
+    // The module registry should not contain absolute paths
     const dataDir = path_1.default.join(generatedFilesDir, plugin.name, pluginId);
     const pluginRouteContext = {
         name: plugin.name,
         id: pluginId,
     };
-    const pluginRouteContextModulePath = path_1.default.join(dataDir, `${(0, utils_1.docuHash)('pluginRouteContextModule')}.json`);
+    const pluginRouteContextModulePath = path_1.default.join(dataDir, `__plugin.json`);
     // TODO not ideal place to generate that file
+    // move to codegen step instead!
     await (0, utils_1.generate)('/', pluginRouteContextModulePath, JSON.stringify(pluginRouteContext, null, 2));
     const routes = [];
     let globalData;
@@ -39,13 +46,14 @@ async function createPluginActionsUtils({ plugin, generatedFilesDir, baseUrl, tr
                 ...finalRouteConfig,
                 context: {
                     ...(finalRouteConfig.context && { data: finalRouteConfig.context }),
-                    plugin: pluginRouteContextModulePath,
+                    plugin: aliasedSource(pluginRouteContextModulePath),
                 },
             });
         },
         async createData(name, data) {
             const modulePath = path_1.default.join(dataDir, name);
-            await (0, utils_1.generate)(dataDir, name, data);
+            const dataString = typeof data === 'string' ? data : JSON.stringify(data, null, 2);
+            await (0, utils_1.generate)(dataDir, name, dataString);
             return modulePath;
         },
         setGlobalData(data) {

package/lib/server/plugins/plugins.d.ts

@@ -4,10 +4,10 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { LoadContext, RouteConfig, GlobalData, PluginIdentifier, LoadedPlugin } from '@docusaurus/types';
+import type { LoadContext, GlobalData, PluginIdentifier, LoadedPlugin, PluginRouteConfig } from '@docusaurus/types';
 export type LoadPluginsResult = {
     plugins: LoadedPlugin[];
-    routes: RouteConfig[];
+    routes: PluginRouteConfig[];
     globalData: GlobalData;
 };
 /**

package/lib/server/plugins/plugins.js

@@ -101,33 +101,30 @@ async function executePluginAllContentLoaded({ plugin, context, allContent, }) {
 async function executeAllPluginsAllContentLoaded({ plugins, context, }) {
     return utils_1.PerfLogger.async(`allContentLoaded()`, async () => {
         const allContent = (0, pluginsUtils_1.aggregateAllContent)(plugins);
-        const routes = [];
-        const globalData = {};
+        const allRoutes = [];
+        const allGlobalData = {};
         await Promise.all(plugins.map(async (plugin) => {
             var _a;
-            const { routes: pluginRoutes, globalData: pluginGlobalData } = await executePluginAllContentLoaded({
+            const { routes, globalData: pluginGlobalData } = await executePluginAllContentLoaded({
                 plugin,
                 context,
                 allContent,
             });
-            routes.push(...pluginRoutes);
+            const pluginRoutes = routes.map((route) => (0, pluginsUtils_1.toPluginRoute)({ plugin, route }));
+            allRoutes.push(...pluginRoutes);
             if (pluginGlobalData !== undefined) {
-                globalData[_a = plugin.name] ?? (globalData[_a] = {});
-                globalData[plugin.name][plugin.options.id] = pluginGlobalData;
+                allGlobalData[_a = plugin.name] ?? (allGlobalData[_a] = {});
+                allGlobalData[plugin.name][plugin.options.id] = pluginGlobalData;
             }
         }));
-        return { routes, globalData };
+        return { routes: allRoutes, globalData: allGlobalData };
     });
 }
 // This merges plugins routes and global data created from both lifecycles:
 // - contentLoaded()
 // - allContentLoaded()
-function mergeResults({ plugins, allContentLoadedResult, }) {
-    const routes = [
-        ...(0, pluginsUtils_1.aggregateRoutes)(plugins),
-        ...allContentLoadedResult.routes,
-    ];
-    (0, routeConfig_1.sortRoutes)(routes);
+function mergeResults({ baseUrl, plugins, allContentLoadedResult, }) {
+    const routes = (0, routeConfig_1.sortRoutes)([...(0, pluginsUtils_1.aggregateRoutes)(plugins), ...allContentLoadedResult.routes], baseUrl);
     const globalData = (0, pluginsUtils_1.mergeGlobalData)((0, pluginsUtils_1.aggregateGlobalData)(plugins), allContentLoadedResult.globalData);
     return { routes, globalData };
 }
@@ -148,6 +145,7 @@ async function loadPlugins(context) {
             context,
         });
         const { routes, globalData } = mergeResults({
+            baseUrl: context.baseUrl,
             plugins,
             allContentLoadedResult,
         });
@@ -179,6 +177,7 @@ async function reloadPlugin({ pluginIdentifier, plugins: previousPlugins, contex
             context,
         });
         const { routes, globalData } = mergeResults({
+            baseUrl: context.baseUrl,
             plugins,
             allContentLoadedResult,
         });

package/lib/server/plugins/pluginsUtils.d.ts

@@ -4,13 +4,17 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { AllContent, GlobalData, InitializedPlugin, LoadedPlugin, PluginIdentifier, RouteConfig } from '@docusaurus/types';
+import type { AllContent, GlobalData, InitializedPlugin, LoadedPlugin, PluginIdentifier, PluginRouteConfig, RouteConfig } from '@docusaurus/types';
 export declare function getPluginByIdentifier<P extends InitializedPlugin>({ plugins, pluginIdentifier, }: {
     pluginIdentifier: PluginIdentifier;
     plugins: P[];
 }): P;
 export declare function aggregateAllContent(loadedPlugins: LoadedPlugin[]): AllContent;
-export declare function aggregateRoutes(loadedPlugins: LoadedPlugin[]): RouteConfig[];
+export declare function toPluginRoute({ plugin, route, }: {
+    plugin: LoadedPlugin;
+    route: RouteConfig;
+}): PluginRouteConfig;
+export declare function aggregateRoutes(loadedPlugins: LoadedPlugin[]): PluginRouteConfig[];
 export declare function aggregateGlobalData(loadedPlugins: LoadedPlugin[]): GlobalData;
 export declare function mergeGlobalData(...globalDataList: GlobalData[]): GlobalData;
 export declare function formatPluginName(plugin: InitializedPlugin | PluginIdentifier): string;

package/lib/server/plugins/pluginsUtils.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatPluginName = exports.mergeGlobalData = exports.aggregateGlobalData = exports.aggregateRoutes = exports.aggregateAllContent = exports.getPluginByIdentifier = void 0;
+exports.formatPluginName = exports.mergeGlobalData = exports.aggregateGlobalData = exports.aggregateRoutes = exports.toPluginRoute = exports.aggregateAllContent = exports.getPluginByIdentifier = void 0;
 const tslib_1 = require("tslib");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
@@ -28,8 +28,12 @@ function aggregateAllContent(loadedPlugins) {
         .value();
 }
 exports.aggregateAllContent = aggregateAllContent;
+function toPluginRoute({ plugin, route, }) {
+    return { plugin: { name: plugin.name, id: plugin.options.id }, ...route };
+}
+exports.toPluginRoute = toPluginRoute;
 function aggregateRoutes(loadedPlugins) {
-    return loadedPlugins.flatMap((p) => p.routes);
+    return loadedPlugins.flatMap((plugin) => plugin.routes.map((route) => toPluginRoute({ plugin, route })));
 }
 exports.aggregateRoutes = aggregateRoutes;
 function aggregateGlobalData(loadedPlugins) {

package/lib/server/plugins/routeConfig.d.ts

@@ -7,5 +7,5 @@
 import { type ApplyTrailingSlashParams } from '@docusaurus/utils-common';
 import type { RouteConfig } from '@docusaurus/types';
 /** Recursively applies trailing slash config to all nested routes. */
-export declare function applyRouteTrailingSlash(route: RouteConfig, params: ApplyTrailingSlashParams): RouteConfig;
-export declare function sortRoutes(routeConfigs: RouteConfig[], baseUrl?: string): void;
+export declare function applyRouteTrailingSlash<Route extends RouteConfig>(route: Route, params: ApplyTrailingSlashParams): Route;
+export declare function sortRoutes<Route extends RouteConfig>(routesToSort: Route[], baseUrl: string): Route[];

package/lib/server/plugins/routeConfig.js

@@ -19,7 +19,8 @@ function applyRouteTrailingSlash(route, params) {
     };
 }
 exports.applyRouteTrailingSlash = applyRouteTrailingSlash;
-function sortRoutes(routeConfigs, baseUrl = '/') {
+function sortRoutes(routesToSort, baseUrl) {
+    const routeConfigs = [...routesToSort];
     // Sort the route config. This ensures that route with nested
     // routes is always placed last.
     routeConfigs.sort((a, b) => {
@@ -36,6 +37,22 @@ function sortRoutes(routeConfigs, baseUrl = '/') {
         if (!a.routes && b.routes) {
             return -1;
         }
+        // If both are parent routes (for example routeBasePath: "/" and "/docs/"
+        // We must order them carefully in case of overlapping paths
+        if (a.routes && b.routes) {
+            if (a.path === b.path) {
+                // We don't really support that kind of routing ATM
+                // React-Router by default will only "enter" a single parent route
+            }
+            else {
+                if (a.path.includes(b.path)) {
+                    return -1;
+                }
+                if (b.path.includes(a.path)) {
+                    return 1;
+                }
+            }
+        }
         // Higher priority get placed first.
         if (a.priority || b.priority) {
             const priorityA = a.priority ?? 0;
@@ -49,8 +66,9 @@ function sortRoutes(routeConfigs, baseUrl = '/') {
     });
     routeConfigs.forEach((routeConfig) => {
         if (routeConfig.routes) {
-            sortRoutes(routeConfig.routes, baseUrl);
+            routeConfig.routes = sortRoutes(routeConfig.routes, baseUrl);
         }
     });
+    return routeConfigs;
 }
 exports.sortRoutes = sortRoutes;

package/lib/ssg.d.ts

@@ -4,6 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+/// <reference path="../src/deps.d.ts" />
 import type { AppRenderer, SiteCollectedData } from './common';
 import type { Manifest } from 'react-loadable-ssr-addon-v5-slorber';
 import type { SSRTemplateCompiled } from './templates/templates';

package/lib/webpack/base.js

@@ -88,9 +88,9 @@ async function createBaseConfig({ props, isServer, minify, }) {
         },
         devtool: isProd ? undefined : 'eval-cheap-module-source-map',
         resolve: {
-            unsafeCache: false,
+            unsafeCache: false, // Not enabled, does not seem to improve perf much
             extensions: ['.wasm', '.mjs', '.js', '.jsx', '.ts', '.tsx', '.json'],
-            symlinks: true,
+            symlinks: true, // See https://github.com/facebook/docusaurus/issues/3272
             roots: [
                 // Allow resolution of url("/fonts/xyz.ttf") by webpack
                 // See https://webpack.js.org/configuration/resolve/#resolveroots

package/lib/webpack/utils.d.ts

@@ -18,9 +18,9 @@ export declare function getBabelOptions({ isServer, babelOptions, }?: {
     isServer?: boolean;
     babelOptions?: TransformOptions | string;
 }): TransformOptions;
-export declare const getCustomizableJSLoader: (jsLoader?: "babel" | ((isServer: boolean) => RuleSetRule)) => ({ isServer, babelOptions, }: {
+export declare const getCustomizableJSLoader: (jsLoader?: 'babel' | ((isServer: boolean) => RuleSetRule)) => ({ isServer, babelOptions, }: {
     isServer: boolean;
-    babelOptions?: string | TransformOptions | undefined;
+    babelOptions?: TransformOptions | string;
 }) => RuleSetRule;
 /**
  * Helper function to modify webpack config

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "3.2.1",
+  "version": "3.3.0",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -43,14 +43,12 @@
     "@babel/runtime": "^7.22.6",
     "@babel/runtime-corejs3": "^7.22.6",
     "@babel/traverse": "^7.22.8",
-    "@docusaurus/cssnano-preset": "3.2.1",
-    "@docusaurus/logger": "3.2.1",
-    "@docusaurus/mdx-loader": "3.2.1",
-    "@docusaurus/react-loadable": "5.5.2",
-    "@docusaurus/utils": "3.2.1",
-    "@docusaurus/utils-common": "3.2.1",
-    "@docusaurus/utils-validation": "3.2.1",
-    "@svgr/webpack": "^6.5.1",
+    "@docusaurus/cssnano-preset": "3.3.0",
+    "@docusaurus/logger": "3.3.0",
+    "@docusaurus/mdx-loader": "3.3.0",
+    "@docusaurus/utils": "3.3.0",
+    "@docusaurus/utils-common": "3.3.0",
+    "@docusaurus/utils-validation": "3.3.0",
     "autoprefixer": "^10.4.14",
     "babel-loader": "^9.1.3",
     "babel-plugin-dynamic-import-node": "^2.3.3",
@@ -64,8 +62,8 @@
     "copy-webpack-plugin": "^11.0.0",
     "core-js": "^3.31.1",
     "css-loader": "^6.8.1",
-    "css-minimizer-webpack-plugin": "^4.2.2",
-    "cssnano": "^5.1.15",
+    "css-minimizer-webpack-plugin": "^5.0.1",
+    "cssnano": "^6.1.2",
     "del": "^6.1.1",
     "detect-port": "^1.5.1",
     "escape-html": "^1.0.3",
@@ -85,7 +83,7 @@
     "prompts": "^2.4.2",
     "react-dev-utils": "^12.0.1",
     "react-helmet-async": "^1.3.0",
-    "react-loadable": "npm:@docusaurus/react-loadable@5.5.2",
+    "react-loadable": "npm:@docusaurus/react-loadable@6.0.0",
     "react-loadable-ssr-addon-v5-slorber": "^1.0.1",
     "react-router": "^5.3.4",
     "react-router-config": "^5.1.1",
@@ -105,8 +103,8 @@
     "webpackbar": "^5.0.2"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.2.1",
-    "@docusaurus/types": "3.2.1",
+    "@docusaurus/module-type-aliases": "3.3.0",
+    "@docusaurus/types": "3.3.0",
     "@total-typescript/shoehorn": "^0.1.2",
     "@types/detect-port": "^1.3.3",
     "@types/react-dom": "^18.2.7",
@@ -126,5 +124,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "f268e15264e208e6faf26117258162e988b53773"
+  "gitHead": "2ec4e078b5ca0c57f2cc04f2fe564d524bb5e858"
 }