@docusaurus/core 0.0.0-6106 → 0.0.0-6110

package/lib/client/renderToHtml.js

@@ -5,57 +5,21 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { renderToPipeableStream } from 'react-dom/server';
-import { Writable } from 'stream';
+import { PassThrough } from 'node:stream';
+import { text } from 'node:stream/consumers';
+// See also https://github.com/facebook/react/issues/31134
+// See also https://github.com/facebook/docusaurus/issues/9985#issuecomment-2396367797
 export async function renderToHtml(app) {
-    // Inspired from
-    // https://react.dev/reference/react-dom/server/renderToPipeableStream#waiting-for-all-content-to-load-for-crawlers-and-static-generation
-    // https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby/cache-dir/static-entry.js
-    const writableStream = new WritableAsPromise();
-    const { pipe } = renderToPipeableStream(app, {
-        onError(error) {
-            writableStream.destroy(error);
-        },
-        onAllReady() {
-            pipe(writableStream);
-        },
-    });
-    return writableStream.getPromise();
-}
-// WritableAsPromise inspired by https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby/cache-dir/server-utils/writable-as-promise.js
-/* eslint-disable no-underscore-dangle */
-class WritableAsPromise extends Writable {
-    _output;
-    _deferred;
-    constructor() {
-        super();
-        this._output = ``;
-        this._deferred = {
-            promise: null,
-            resolve: () => null,
-            reject: () => null,
-        };
-        this._deferred.promise = new Promise((resolve, reject) => {
-            this._deferred.resolve = resolve;
-            this._deferred.reject = reject;
+    return new Promise((resolve, reject) => {
+        const passThrough = new PassThrough();
+        const { pipe } = renderToPipeableStream(app, {
+            onError(error) {
+                reject(error);
+            },
+            onAllReady() {
+                pipe(passThrough);
+                text(passThrough).then(resolve, reject);
+            },
         });
-    }
-    _write(chunk, _enc, next) {
-        this._output += chunk.toString();
-        next();
-    }
-    _destroy(error, next) {
-        if (error instanceof Error) {
-            this._deferred.reject(error);
-        }
-        else {
-            next();
-        }
-    }
-    end() {
-        this._deferred.resolve(this._output);
-        return this.destroy();
-    }
-    getPromise() {
-        return this._deferred.promise;
-    }
+    });
 }

package/lib/client/serverEntry.js

@@ -31,6 +31,8 @@ const render = async ({ pathname }) => {
     </Loadable.Capture>);
     const html = await renderToHtml(app);
     const collectedData = {
+        // TODO Docusaurus v4 refactor: helmet state is non-serializable
+        //  this makes it impossible to run SSG in a worker thread
         helmet: helmetContext.helmet,
         anchors: statefulBrokenLinks.getCollectedAnchors(),
         links: statefulBrokenLinks.getCollectedLinks(),

package/lib/commands/build.js

@@ -20,9 +20,7 @@ const client_1 = require("../webpack/client");
 const server_1 = tslib_1.__importDefault(require("../webpack/server"));
 const configure_1 = require("../webpack/configure");
 const i18n_1 = require("../server/i18n");
-const ssg_1 = require("../ssg");
-const templates_1 = require("../templates/templates");
-const ssr_html_template_1 = tslib_1.__importDefault(require("../templates/ssr.html.template"));
+const ssgExecutor_1 = require("../ssg/ssgExecutor");
 async function build(siteDirParam = '.', cliOptions = {}) {
     process.env.BABEL_ENV = 'production';
     process.env.NODE_ENV = 'production';
@@ -121,7 +119,7 @@ async function buildLocale({ siteDir, locale, cliOptions, }) {
             currentBundler: configureWebpackUtils.currentBundler,
         });
     });
-    const { collectedData } = await logger_1.PerfLogger.async('SSG', () => executeSSG({
+    const { collectedData } = await logger_1.PerfLogger.async('SSG', () => (0, ssgExecutor_1.executeSSG)({
         props,
         serverBundlePath,
         clientManifestPath,
@@ -133,43 +131,6 @@ async function buildLocale({ siteDir, locale, cliOptions, }) {
     // TODO execute this in parallel to postBuild?
     await logger_1.PerfLogger.async('Broken links checker', () => executeBrokenLinksCheck({ props, collectedData }));
     logger_1.default.success `Generated static files in path=${path_1.default.relative(process.cwd(), outDir)}.`;
-    return outDir;
-}
-async function executeSSG({ props, serverBundlePath, clientManifestPath, router, }) {
-    const manifest = await logger_1.PerfLogger.async('Read client manifest', () => fs_extra_1.default.readJSON(clientManifestPath, 'utf-8'));
-    const ssrTemplate = await logger_1.PerfLogger.async('Compile SSR template', () => (0, templates_1.compileSSRTemplate)(props.siteConfig.ssrTemplate ?? ssr_html_template_1.default));
-    const params = {
-        trailingSlash: props.siteConfig.trailingSlash,
-        outDir: props.outDir,
-        baseUrl: props.baseUrl,
-        manifest,
-        headTags: props.headTags,
-        preBodyTags: props.preBodyTags,
-        postBodyTags: props.postBodyTags,
-        ssrTemplate,
-        noIndex: props.siteConfig.noIndex,
-        DOCUSAURUS_VERSION: utils_1.DOCUSAURUS_VERSION,
-    };
-    if (router === 'hash') {
-        logger_1.PerfLogger.start('Generate Hash Router entry point');
-        const content = (0, templates_1.renderHashRouterTemplate)({ params });
-        await (0, ssg_1.generateHashRouterEntrypoint)({ content, params });
-        logger_1.PerfLogger.end('Generate Hash Router entry point');
-        return { collectedData: {} };
-    }
-    const [renderer, htmlMinifier] = await Promise.all([
-        logger_1.PerfLogger.async('Load App renderer', () => (0, ssg_1.loadAppRenderer)({
-            serverBundlePath,
-        })),
-        logger_1.PerfLogger.async('Load HTML minifier', () => (0, bundler_1.getHtmlMinifier)({ siteConfig: props.siteConfig })),
-    ]);
-    const ssgResult = await logger_1.PerfLogger.async('Generate static files', () => (0, ssg_1.generateStaticFiles)({
-        pathnames: props.routesPaths,
-        renderer,
-        params,
-        htmlMinifier,
-    }));
-    return ssgResult;
 }
 async function executePluginsPostBuild({ plugins, props, collectedData, }) {
     const head = lodash_1.default.mapValues(collectedData, (d) => d.helmet);

package/lib/ssg/ssg.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { SSGParams } from './ssgParams';
+import type { AppRenderer, SiteCollectedData } from '../common';
+export declare function loadAppRenderer({ serverBundlePath, }: {
+    serverBundlePath: string;
+}): Promise<AppRenderer>;
+export declare function printSSGWarnings(results: {
+    pathname: string;
+    warnings: string[];
+}[]): void;
+export declare function generateStaticFiles({ pathnames, params, }: {
+    pathnames: string[];
+    params: SSGParams;
+}): Promise<{
+    collectedData: SiteCollectedData;
+}>;

package/lib/{ssg.js → ssg/ssg.js}

@@ -9,7 +9,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.loadAppRenderer = loadAppRenderer;
 exports.printSSGWarnings = printSSGWarnings;
 exports.generateStaticFiles = generateStaticFiles;
-exports.generateHashRouterEntrypoint = generateHashRouterEntrypoint;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const module_1 = require("module");
@@ -18,15 +17,9 @@ const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const eval_1 = tslib_1.__importDefault(require("eval"));
 const p_map_1 = tslib_1.__importDefault(require("p-map"));
 const logger_1 = tslib_1.__importStar(require("@docusaurus/logger"));
-const templates_1 = require("./templates/templates");
-// Secret way to set SSR plugin concurrency option
-// Waiting for feedback before documenting this officially?
-const Concurrency = process.env.DOCUSAURUS_SSR_CONCURRENCY
-    ? parseInt(process.env.DOCUSAURUS_SSR_CONCURRENCY, 10)
-    : // Not easy to define a reasonable option default
-        // Will still be better than Infinity
-        // See also https://github.com/sindresorhus/p-map/issues/24
-        32;
+const bundler_1 = require("@docusaurus/bundler");
+const ssgTemplate_1 = require("./ssgTemplate");
+const ssgUtils_1 = require("./ssgUtils");
 async function loadAppRenderer({ serverBundlePath, }) {
     const source = await logger_1.PerfLogger.async(`Load server bundle`, () => fs_extra_1.default.readFile(serverBundlePath));
     logger_1.PerfLogger.log(`Server bundle size = ${(source.length / 1024000).toFixed(3)} MB`);
@@ -50,23 +43,6 @@ async function loadAppRenderer({ serverBundlePath, }) {
     }
     return serverEntry.default;
 }
-function pathnameToFilename({ pathname, trailingSlash, }) {
-    const outputFileName = pathname.replace(/^[/\\]/, ''); // Remove leading slashes for webpack-dev-server
-    // Paths ending with .html are left untouched
-    if (/\.html?$/i.test(outputFileName)) {
-        return outputFileName;
-    }
-    // Legacy retro-compatible behavior
-    if (typeof trailingSlash === 'undefined') {
-        return path_1.default.join(outputFileName, 'index.html');
-    }
-    // New behavior: we can say if we prefer file/folder output
-    // Useful resource: https://github.com/slorber/trailing-slash-guide
-    if (pathname === '' || pathname.endsWith('/') || trailingSlash) {
-        return path_1.default.join(outputFileName, 'index.html');
-    }
-    return `${outputFileName}.html`;
-}
 function printSSGWarnings(results) {
     // Escape hatch because SWC is quite aggressive to report errors
     // See https://github.com/facebook/docusaurus/pull/10554
@@ -103,7 +79,16 @@ Troubleshooting guide: https://github.com/facebook/docusaurus/discussions/10580
         logger_1.default.warn(message);
     }
 }
-async function generateStaticFiles({ pathnames, renderer, params, htmlMinifier, }) {
+async function generateStaticFiles({ pathnames, params, }) {
+    const [renderer, htmlMinifier, ssgTemplate] = await Promise.all([
+        logger_1.PerfLogger.async('Load App renderer', () => loadAppRenderer({
+            serverBundlePath: params.serverBundlePath,
+        })),
+        logger_1.PerfLogger.async('Load HTML minifier', () => (0, bundler_1.getHtmlMinifier)({
+            type: params.htmlMinifierType,
+        })),
+        logger_1.PerfLogger.async('Compile SSG template', () => (0, ssgTemplate_1.compileSSGTemplate)(params.ssgTemplateContent)),
+    ]);
     // Note that we catch all async errors on purpose
     // Docusaurus presents all the SSG errors to the user, not just the first one
     const results = await (0, p_map_1.default)(pathnames, async (pathname) => generateStaticFile({
@@ -111,6 +96,7 @@ async function generateStaticFiles({ pathnames, renderer, params, htmlMinifier,
         renderer,
         params,
         htmlMinifier,
+        ssgTemplate,
     }).then((result) => ({
         pathname,
         result,
@@ -121,7 +107,7 @@ async function generateStaticFiles({ pathnames, renderer, params, htmlMinifier,
         result: null,
         error: error,
         warnings: [],
-    })), { concurrency: Concurrency });
+    })), { concurrency: ssgUtils_1.SSGConcurrency });
     printSSGWarnings(results);
     const [allSSGErrors, allSSGSuccesses] = lodash_1.default.partition(results, (result) => !!result.error);
     if (allSSGErrors.length > 0) {
@@ -140,25 +126,26 @@ async function generateStaticFiles({ pathnames, renderer, params, htmlMinifier,
         .value();
     return { collectedData };
 }
-async function generateStaticFile({ pathname, renderer, params, htmlMinifier, }) {
+async function generateStaticFile({ pathname, renderer, params, htmlMinifier, ssgTemplate, }) {
     try {
         // This only renders the app HTML
         const result = await renderer({
             pathname,
         });
         // This renders the full page HTML, including head tags...
-        const fullPageHtml = (0, templates_1.renderSSRTemplate)({
+        const fullPageHtml = (0, ssgTemplate_1.renderSSGTemplate)({
             params,
             result,
+            ssgTemplate,
         });
         const minifierResult = await htmlMinifier.minify(fullPageHtml);
-        await writeStaticFile({
+        await (0, ssgUtils_1.writeStaticFile)({
             pathname,
             content: minifierResult.code,
             params,
         });
         return {
-            ...result,
+            collectedData: result.collectedData,
             // As of today, only the html minifier can emit SSG warnings
             warnings: minifierResult.warnings,
         };
@@ -184,22 +171,3 @@ It might also require to wrap your client code in ${logger_1.default.code('useEf
     }
     return parts.join('\n');
 }
-async function generateHashRouterEntrypoint({ content, params, }) {
-    await writeStaticFile({
-        pathname: '/',
-        content,
-        params,
-    });
-}
-async function writeStaticFile({ content, pathname, params, }) {
-    function removeBaseUrl(p, baseUrl) {
-        return baseUrl === '/' ? p : p.replace(new RegExp(`^${baseUrl}`), '/');
-    }
-    const filename = pathnameToFilename({
-        pathname: removeBaseUrl(pathname, params.baseUrl),
-        trailingSlash: params.trailingSlash,
-    });
-    const filePath = path_1.default.join(params.outDir, filename);
-    await fs_extra_1.default.ensureDir(path_1.default.dirname(filePath));
-    await fs_extra_1.default.writeFile(filePath, content);
-}

package/lib/ssg/ssgExecutor.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { Props, RouterType } from '@docusaurus/types';
+import type { SiteCollectedData } from '../common';
+export declare function executeSSG({ props, serverBundlePath, clientManifestPath, router, }: {
+    props: Props;
+    serverBundlePath: string;
+    clientManifestPath: string;
+    router: RouterType;
+}): Promise<{
+    collectedData: SiteCollectedData;
+}>;

package/lib/ssg/ssgExecutor.js

@@ -0,0 +1,34 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.executeSSG = executeSSG;
+const logger_1 = require("@docusaurus/logger");
+const ssgParams_1 = require("./ssgParams");
+const ssg_1 = require("./ssg");
+const ssgTemplate_1 = require("./ssgTemplate");
+const ssgUtils_1 = require("./ssgUtils");
+// TODO Docusaurus v4 - introduce SSG worker threads
+async function executeSSG({ props, serverBundlePath, clientManifestPath, router, }) {
+    const params = await (0, ssgParams_1.createSSGParams)({
+        serverBundlePath,
+        clientManifestPath,
+        props,
+    });
+    if (router === 'hash') {
+        logger_1.PerfLogger.start('Generate Hash Router entry point');
+        const content = await (0, ssgTemplate_1.renderHashRouterTemplate)({ params });
+        await (0, ssgUtils_1.generateHashRouterEntrypoint)({ content, params });
+        logger_1.PerfLogger.end('Generate Hash Router entry point');
+        return { collectedData: {} };
+    }
+    const ssgResult = await logger_1.PerfLogger.async('Generate static files', () => (0, ssg_1.generateStaticFiles)({
+        pathnames: props.routesPaths,
+        params,
+    }));
+    return ssgResult;
+}

package/lib/ssg/ssgParams.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { Manifest } from 'react-loadable-ssr-addon-v5-slorber';
+import type { Props } from '@docusaurus/types';
+import type { HtmlMinifierType } from '@docusaurus/bundler';
+export type SSGParams = {
+    trailingSlash: boolean | undefined;
+    manifest: Manifest;
+    headTags: string;
+    preBodyTags: string;
+    postBodyTags: string;
+    outDir: string;
+    baseUrl: string;
+    noIndex: boolean;
+    DOCUSAURUS_VERSION: string;
+    htmlMinifierType: HtmlMinifierType;
+    serverBundlePath: string;
+    ssgTemplateContent: string;
+};
+export declare function createSSGParams({ props, serverBundlePath, clientManifestPath, }: {
+    props: Props;
+    serverBundlePath: string;
+    clientManifestPath: string;
+}): Promise<SSGParams>;

package/lib/ssg/ssgParams.js

@@ -0,0 +1,36 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createSSGParams = createSSGParams;
+const tslib_1 = require("tslib");
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const utils_1 = require("@docusaurus/utils");
+const logger_1 = require("@docusaurus/logger");
+const ssgTemplate_html_1 = tslib_1.__importDefault(require("./ssgTemplate.html"));
+async function createSSGParams({ props, serverBundlePath, clientManifestPath, }) {
+    const manifest = await logger_1.PerfLogger.async('Read client manifest', () => fs_extra_1.default.readJSON(clientManifestPath, 'utf-8'));
+    const params = {
+        trailingSlash: props.siteConfig.trailingSlash,
+        outDir: props.outDir,
+        baseUrl: props.baseUrl,
+        manifest,
+        headTags: props.headTags,
+        preBodyTags: props.preBodyTags,
+        postBodyTags: props.postBodyTags,
+        ssgTemplateContent: props.siteConfig.ssrTemplate ?? ssgTemplate_html_1.default,
+        noIndex: props.siteConfig.noIndex,
+        DOCUSAURUS_VERSION: utils_1.DOCUSAURUS_VERSION,
+        serverBundlePath,
+        htmlMinifierType: props.siteConfig.future.experimental_faster
+            .swcHtmlMinimizer
+            ? 'swc'
+            : 'terser',
+    };
+    // Useless but ensures that SSG params remain serializable
+    return structuredClone(params);
+}

package/lib/{templates/templates.d.ts → ssg/ssgTemplate.d.ts}

@@ -4,9 +4,9 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { SSGParams } from '../ssg';
+import type { SSGParams } from './ssgParams';
 import type { AppRenderResult } from '../common';
-export type SSRTemplateData = {
+export type SSGTemplateData = {
     appHtml: string;
     baseUrl: string;
     htmlAttributes: string;
@@ -20,12 +20,13 @@ export type SSRTemplateData = {
     noIndex: boolean;
     version: string;
 };
-export type SSRTemplateCompiled = (data: SSRTemplateData) => string;
-export declare function compileSSRTemplate(template: string): Promise<SSRTemplateCompiled>;
-export declare function renderSSRTemplate({ params, result, }: {
+export type SSGTemplateCompiled = (data: SSGTemplateData) => string;
+export declare function compileSSGTemplate(template: string): Promise<SSGTemplateCompiled>;
+export declare function renderSSGTemplate({ params, result, ssgTemplate, }: {
     params: SSGParams;
     result: AppRenderResult;
+    ssgTemplate: SSGTemplateCompiled;
 }): string;
 export declare function renderHashRouterTemplate({ params, }: {
     params: SSGParams;
-}): string;
+}): Promise<string>;

package/lib/{templates/templates.js → ssg/ssgTemplate.js}

@@ -6,13 +6,14 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.compileSSRTemplate = compileSSRTemplate;
-exports.renderSSRTemplate = renderSSRTemplate;
+exports.compileSSGTemplate = compileSSGTemplate;
+exports.renderSSGTemplate = renderSSGTemplate;
 exports.renderHashRouterTemplate = renderHashRouterTemplate;
 const tslib_1 = require("tslib");
 const eta = tslib_1.__importStar(require("eta"));
 const react_loadable_ssr_addon_v5_slorber_1 = require("react-loadable-ssr-addon-v5-slorber");
-async function compileSSRTemplate(template) {
+const logger_1 = require("@docusaurus/logger");
+async function compileSSGTemplate(template) {
     const compiledTemplate = eta.compile(template.trim(), {
         rmWhitespace: true,
     });
@@ -32,8 +33,8 @@ function getScriptsAndStylesheets({ modules, manifest, }) {
     const scripts = (bundles.js ?? []).map((b) => b.file);
     return { scripts, stylesheets };
 }
-function renderSSRTemplate({ params, result, }) {
-    const { baseUrl, headTags, preBodyTags, postBodyTags, manifest, noIndex, DOCUSAURUS_VERSION, ssrTemplate, } = params;
+function renderSSGTemplate({ params, result, ssgTemplate, }) {
+    const { baseUrl, headTags, preBodyTags, postBodyTags, manifest, noIndex, DOCUSAURUS_VERSION, } = params;
     const { html: appHtml, collectedData: { modules, helmet }, } = result;
     const { scripts, stylesheets } = getScriptsAndStylesheets({ manifest, modules });
     const htmlAttributes = helmet.htmlAttributes.toString();
@@ -59,12 +60,13 @@ function renderSSRTemplate({ params, result, }) {
         noIndex,
         version: DOCUSAURUS_VERSION,
     };
-    return ssrTemplate(data);
+    return ssgTemplate(data);
 }
-function renderHashRouterTemplate({ params, }) {
+async function renderHashRouterTemplate({ params, }) {
     const { 
     // baseUrl,
-    headTags, preBodyTags, postBodyTags, manifest, DOCUSAURUS_VERSION, ssrTemplate, } = params;
+    headTags, preBodyTags, postBodyTags, manifest, DOCUSAURUS_VERSION, ssgTemplateContent, } = params;
+    const ssgTemplate = await logger_1.PerfLogger.async('Compile SSG template', () => compileSSGTemplate(ssgTemplateContent));
     const { scripts, stylesheets } = getScriptsAndStylesheets({
         manifest,
         modules: [],
@@ -83,5 +85,5 @@ function renderHashRouterTemplate({ params, }) {
         noIndex: false,
         version: DOCUSAURUS_VERSION,
     };
-    return ssrTemplate(data);
+    return ssgTemplate(data);
 }

package/lib/ssg/ssgUtils.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { SSGParams } from './ssgParams';
+export declare const SSGConcurrency: number;
+export declare function generateHashRouterEntrypoint({ content, params, }: {
+    content: string;
+    params: SSGParams;
+}): Promise<void>;
+export declare function writeStaticFile({ content, pathname, params, }: {
+    content: string;
+    pathname: string;
+    params: SSGParams;
+}): Promise<void>;

package/lib/ssg/ssgUtils.js

@@ -0,0 +1,58 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SSGConcurrency = void 0;
+exports.generateHashRouterEntrypoint = generateHashRouterEntrypoint;
+exports.writeStaticFile = writeStaticFile;
+const tslib_1 = require("tslib");
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const path_1 = tslib_1.__importDefault(require("path"));
+// Secret way to set SSR plugin concurrency option
+// Waiting for feedback before documenting this officially?
+exports.SSGConcurrency = process.env.DOCUSAURUS_SSR_CONCURRENCY
+    ? parseInt(process.env.DOCUSAURUS_SSR_CONCURRENCY, 10)
+    : // Not easy to define a reasonable option default
+        // Will still be better than Infinity
+        // See also https://github.com/sindresorhus/p-map/issues/24
+        32;
+function pathnameToFilename({ pathname, trailingSlash, }) {
+    const outputFileName = pathname.replace(/^[/\\]/, ''); // Remove leading slashes for webpack-dev-server
+    // Paths ending with .html are left untouched
+    if (/\.html?$/i.test(outputFileName)) {
+        return outputFileName;
+    }
+    // Legacy retro-compatible behavior
+    if (typeof trailingSlash === 'undefined') {
+        return path_1.default.join(outputFileName, 'index.html');
+    }
+    // New behavior: we can say if we prefer file/folder output
+    // Useful resource: https://github.com/slorber/trailing-slash-guide
+    if (pathname === '' || pathname.endsWith('/') || trailingSlash) {
+        return path_1.default.join(outputFileName, 'index.html');
+    }
+    return `${outputFileName}.html`;
+}
+async function generateHashRouterEntrypoint({ content, params, }) {
+    await writeStaticFile({
+        pathname: '/',
+        content,
+        params,
+    });
+}
+async function writeStaticFile({ content, pathname, params, }) {
+    function removeBaseUrl(p, baseUrl) {
+        return baseUrl === '/' ? p : p.replace(new RegExp(`^${baseUrl}`), '/');
+    }
+    const filename = pathnameToFilename({
+        pathname: removeBaseUrl(pathname, params.baseUrl),
+        trailingSlash: params.trailingSlash,
+    });
+    const filePath = path_1.default.join(params.outDir, filename);
+    await fs_extra_1.default.ensureDir(path_1.default.dirname(filePath));
+    await fs_extra_1.default.writeFile(filePath, content);
+}

package/lib/webpack/client.js

@@ -76,7 +76,7 @@ async function createStartClientConfig({ props, minify, poll, faster, configureW
         plugins: [
             // Generates an `index.html` file with the <script> injected.
             new html_webpack_plugin_1.default({
-                template: path_1.default.join(__dirname, '../templates/dev.html.template.ejs'),
+                template: path_1.default.join(__dirname, './templates/dev.html.template.ejs'),
                 // So we can define the position where the scripts are injected.
                 inject: false,
                 filename: 'index.html',

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "0.0.0-6106",
+  "version": "0.0.0-6110",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -33,13 +33,13 @@
     "url": "https://github.com/facebook/docusaurus/issues"
   },
   "dependencies": {
-    "@docusaurus/babel": "0.0.0-6106",
-    "@docusaurus/bundler": "0.0.0-6106",
-    "@docusaurus/logger": "0.0.0-6106",
-    "@docusaurus/mdx-loader": "0.0.0-6106",
-    "@docusaurus/utils": "0.0.0-6106",
-    "@docusaurus/utils-common": "0.0.0-6106",
-    "@docusaurus/utils-validation": "0.0.0-6106",
+    "@docusaurus/babel": "0.0.0-6110",
+    "@docusaurus/bundler": "0.0.0-6110",
+    "@docusaurus/logger": "0.0.0-6110",
+    "@docusaurus/mdx-loader": "0.0.0-6110",
+    "@docusaurus/utils": "0.0.0-6110",
+    "@docusaurus/utils-common": "0.0.0-6110",
+    "@docusaurus/utils-validation": "0.0.0-6110",
     "boxen": "^6.2.1",
     "chalk": "^4.1.2",
     "chokidar": "^3.5.3",
@@ -78,8 +78,8 @@
     "webpack-merge": "^6.0.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-6106",
-    "@docusaurus/types": "0.0.0-6106",
+    "@docusaurus/module-type-aliases": "0.0.0-6110",
+    "@docusaurus/types": "0.0.0-6110",
     "@total-typescript/shoehorn": "^0.1.2",
     "@types/detect-port": "^1.3.3",
     "@types/react-dom": "^18.2.7",
@@ -100,5 +100,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "ca593b56b8185eaa1fbe07fb5ae9ed86494d6072"
+  "gitHead": "3e5c6c714c37c6d3592bfc2a0679dbff3d825b3e"
 }

package/lib/ssg.d.ts

@@ -1,41 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-import type { AppRenderer, SiteCollectedData } from './common';
-import type { HtmlMinifier } from '@docusaurus/bundler';
-import type { Manifest } from 'react-loadable-ssr-addon-v5-slorber';
-import type { SSRTemplateCompiled } from './templates/templates';
-export type SSGParams = {
-    trailingSlash: boolean | undefined;
-    manifest: Manifest;
-    headTags: string;
-    preBodyTags: string;
-    postBodyTags: string;
-    outDir: string;
-    baseUrl: string;
-    noIndex: boolean;
-    DOCUSAURUS_VERSION: string;
-    ssrTemplate: SSRTemplateCompiled;
-};
-export declare function loadAppRenderer({ serverBundlePath, }: {
-    serverBundlePath: string;
-}): Promise<AppRenderer>;
-export declare function printSSGWarnings(results: {
-    pathname: string;
-    warnings: string[];
-}[]): void;
-export declare function generateStaticFiles({ pathnames, renderer, params, htmlMinifier, }: {
-    pathnames: string[];
-    renderer: AppRenderer;
-    params: SSGParams;
-    htmlMinifier: HtmlMinifier;
-}): Promise<{
-    collectedData: SiteCollectedData;
-}>;
-export declare function generateHashRouterEntrypoint({ content, params, }: {
-    content: string;
-    params: SSGParams;
-}): Promise<void>;