@docusaurus/core 2.0.0-beta.fc64c12e4 → 2.0.0

package/lib/server/htmlTags.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 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, LoadedPlugin } from '@docusaurus/types';
+/**
+ * Runs the `injectHtmlTags` lifecycle, and aggregates all plugins' tags into
+ * directly render-able HTML markup.
+ */
+export declare function loadHtmlTags(plugins: LoadedPlugin[]): Pick<Props, 'headTags' | 'preBodyTags' | 'postBodyTags'>;

package/lib/server/htmlTags.js

@@ -0,0 +1,62 @@
+"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.loadHtmlTags = void 0;
+const tslib_1 = require("tslib");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const html_tags_1 = tslib_1.__importDefault(require("html-tags"));
+const void_1 = tslib_1.__importDefault(require("html-tags/void"));
+const escape_html_1 = tslib_1.__importDefault(require("escape-html"));
+function assertIsHtmlTagObject(val) {
+    if (typeof val !== 'object' || !val) {
+        throw new Error(`"${val}" is not a valid HTML tag object.`);
+    }
+    if (typeof val.tagName !== 'string') {
+        throw new Error(`${JSON.stringify(val)} is not a valid HTML tag object. "tagName" must be defined as a string.`);
+    }
+    if (!html_tags_1.default.includes(val.tagName)) {
+        throw new Error(`Error loading ${JSON.stringify(val)}, "${val.tagName}" is not a valid HTML tag.`);
+    }
+}
+function htmlTagObjectToString(tag) {
+    assertIsHtmlTagObject(tag);
+    const isVoidTag = void_1.default.includes(tag.tagName);
+    const tagAttributes = tag.attributes ?? {};
+    const attributes = Object.keys(tagAttributes)
+        .map((attr) => {
+        const value = tagAttributes[attr];
+        if (typeof value === 'boolean') {
+            return value ? attr : undefined;
+        }
+        return `${attr}="${(0, escape_html_1.default)(value)}"`;
+    })
+        .filter((str) => Boolean(str));
+    const openingTag = `<${[tag.tagName].concat(attributes).join(' ')}>`;
+    const innerHTML = (!isVoidTag && tag.innerHTML) || '';
+    const closingTag = isVoidTag ? '' : `</${tag.tagName}>`;
+    return openingTag + innerHTML + closingTag;
+}
+function createHtmlTagsString(tags) {
+    return (Array.isArray(tags) ? tags : [tags])
+        .filter(Boolean)
+        .map((val) => (typeof val === 'string' ? val : htmlTagObjectToString(val)))
+        .join('\n');
+}
+/**
+ * Runs the `injectHtmlTags` lifecycle, and aggregates all plugins' tags into
+ * directly render-able HTML markup.
+ */
+function loadHtmlTags(plugins) {
+    const pluginHtmlTags = plugins.map((plugin) => plugin.injectHtmlTags?.({ content: plugin.content }) ?? {});
+    const tagTypes = ['headTags', 'preBodyTags', 'postBodyTags'];
+    return Object.fromEntries(lodash_1.default.zip(tagTypes, tagTypes.map((type) => pluginHtmlTags
+        .map((tags) => createHtmlTagsString(tags[type]))
+        .join('\n')
+        .trim())));
+}
+exports.loadHtmlTags = loadHtmlTags;

package/lib/server/i18n.d.ts

@@ -4,17 +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 { I18n, DocusaurusConfig, I18nLocaleConfig } from '@docusaurus/types';
+import type { I18n, DocusaurusConfig, I18nLocaleConfig } from '@docusaurus/types';
+import type { LoadContextOptions } from './index';
 export declare function getDefaultLocaleConfig(locale: string): I18nLocaleConfig;
-export declare function shouldWarnAboutNodeVersion(version: number, locales: string[]): boolean;
-export declare function loadI18n(config: DocusaurusConfig, options?: {
-    locale?: string;
-}): Promise<I18n>;
-export declare function localizePath({ pathType, path: originalPath, i18n, options, }: {
-    pathType: 'fs' | 'url';
-    path: string;
-    i18n: I18n;
-    options?: {
-        localizePath?: boolean;
-    };
-}): string;
+export declare function loadI18n(config: DocusaurusConfig, options: Pick<LoadContextOptions, 'locale'>): Promise<I18n>;

package/lib/server/i18n.js

@@ -1,87 +1,53 @@
 "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.localizePath = exports.loadI18n = exports.shouldWarnAboutNodeVersion = exports.getDefaultLocaleConfig = void 0;
+exports.loadI18n = exports.getDefaultLocaleConfig = void 0;
 const tslib_1 = require("tslib");
-const path_1 = tslib_1.__importDefault(require("path"));
-const utils_1 = require("@docusaurus/utils");
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const rtl_detect_1 = require("rtl-detect");
-const constants_1 = require("../constants");
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
 function getDefaultLocaleLabel(locale) {
-    // Intl.DisplayNames is ES2021 - Node14+
-    // https://v8.dev/features/intl-displaynames
-    // @ts-expect-error: wait for TS support of ES2021 feature
-    if (typeof Intl.DisplayNames !== 'undefined') {
-        // @ts-expect-error: wait for TS support of ES2021 feature
-        return new Intl.DisplayNames([locale], { type: 'language' }).of(locale);
-    }
-    return locale;
+    const languageName = new Intl.DisplayNames(locale, { type: 'language' }).of(locale);
+    return (languageName.charAt(0).toLocaleUpperCase(locale) + languageName.substring(1));
 }
 function getDefaultLocaleConfig(locale) {
     return {
         label: getDefaultLocaleLabel(locale),
-        direction: rtl_detect_1.getLangDir(locale),
+        direction: (0, rtl_detect_1.getLangDir)(locale),
+        htmlLang: locale,
+        // If the locale name includes -u-ca-xxx the calendar will be defined
+        calendar: new Intl.Locale(locale).calendar ?? 'gregory',
+        path: locale,
     };
 }
 exports.getDefaultLocaleConfig = getDefaultLocaleConfig;
-function shouldWarnAboutNodeVersion(version, locales) {
-    const isOnlyEnglish = locales.length === 1 && locales.includes('en');
-    const isOlderNodeVersion = version < 14;
-    return isOlderNodeVersion && !isOnlyEnglish;
-}
-exports.shouldWarnAboutNodeVersion = shouldWarnAboutNodeVersion;
-async function loadI18n(config, options = {}) {
-    var _a;
+async function loadI18n(config, options) {
     const { i18n: i18nConfig } = config;
-    const currentLocale = (_a = options.locale) !== null && _a !== void 0 ? _a : i18nConfig.defaultLocale;
+    const currentLocale = options.locale ?? i18nConfig.defaultLocale;
     if (!i18nConfig.locales.includes(currentLocale)) {
-        console.warn(chalk_1.default.yellow(`The locale "${currentLocale}" was not found in your site configuration: Available locales are: ${i18nConfig.locales.join(',')}.
-Note: Docusaurus only support running one locale at a time.`));
+        logger_1.default.warn `The locale name=${currentLocale} was not found in your site configuration: Available locales are: ${i18nConfig.locales}
+Note: Docusaurus only support running one locale at a time.`;
     }
     const locales = i18nConfig.locales.includes(currentLocale)
         ? i18nConfig.locales
         : i18nConfig.locales.concat(currentLocale);
-    if (shouldWarnAboutNodeVersion(constants_1.NODE_MAJOR_VERSION, locales)) {
-        console.warn(chalk_1.default.yellow(`To use Docusaurus i18n, it is strongly advised to use Node.js 14 or later (instead of ${constants_1.NODE_MAJOR_VERSION}).`));
-    }
     function getLocaleConfig(locale) {
         return {
             ...getDefaultLocaleConfig(locale),
             ...i18nConfig.localeConfigs[locale],
         };
     }
-    const localeConfigs = locales.reduce((acc, locale) => {
-        return { ...acc, [locale]: getLocaleConfig(locale) };
-    }, {});
+    const localeConfigs = Object.fromEntries(locales.map((locale) => [locale, getLocaleConfig(locale)]));
     return {
         defaultLocale: i18nConfig.defaultLocale,
         locales,
+        path: i18nConfig.path,
         currentLocale,
         localeConfigs,
     };
 }
 exports.loadI18n = loadI18n;
-function localizePath({ pathType, path: originalPath, i18n, options = {}, }) {
-    const shouldLocalizePath = typeof options.localizePath === 'undefined'
-        ? // By default, we don't localize the path of defaultLocale
-            i18n.currentLocale !== i18n.defaultLocale
-        : options.localizePath;
-    if (shouldLocalizePath) {
-        // FS paths need special care, for Windows support
-        if (pathType === 'fs') {
-            return path_1.default.join(originalPath, path_1.default.sep, i18n.currentLocale, path_1.default.sep);
-        }
-        // Url paths
-        else if (pathType === 'url') {
-            return utils_1.normalizeUrl([originalPath, '/', i18n.currentLocale, '/']);
-        }
-        // should never happen
-        else {
-            throw new Error(`Unhandled path type "${pathType}".`);
-        }
-    }
-    else {
-        return originalPath;
-    }
-}
-exports.localizePath = localizePath;

package/lib/server/index.d.ts

@@ -4,20 +4,35 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { DocusaurusConfig, LoadContext, PluginConfig, Props } from '@docusaurus/types';
+import type { LoadContext, Props } from '@docusaurus/types';
 export declare type LoadContextOptions = {
-    customOutDir?: string;
-    customConfigFilePath?: string;
+    /** Usually the CWD; can be overridden with command argument. */
+    siteDir: string;
+    /** Custom output directory. Can be customized with `--out-dir` option */
+    outDir?: string;
+    /** Custom config path. Can be customized with `--config` option */
+    config?: string;
+    /** Default is `i18n.defaultLocale` */
     locale?: string;
+    /**
+     * `true` means the paths will have the locale prepended; `false` means they
+     * won't (useful for `yarn build -l zh-Hans` where the output should be
+     * emitted into `build/` instead of `build/zh-Hans/`); `undefined` is like the
+     * "smart" option where only non-default locale paths are localized
+     */
     localizePath?: boolean;
 };
-export declare function loadSiteConfig({ siteDir, customConfigFilePath, }: {
-    siteDir: string;
-    customConfigFilePath?: string;
-}): Promise<{
-    siteConfig: DocusaurusConfig;
-    siteConfigPath: string;
-}>;
-export declare function loadContext(siteDir: string, options?: LoadContextOptions): Promise<LoadContext>;
-export declare function loadPluginConfigs(context: LoadContext): PluginConfig[];
-export declare function load(siteDir: string, options?: LoadContextOptions): Promise<Props>;
+/**
+ * Loading context is the very first step in site building. Its options are
+ * directly acquired from CLI options. It mainly loads `siteConfig` and the i18n
+ * context (which includes code translations). The `LoadContext` will be passed
+ * to plugin constructors.
+ */
+export declare function loadContext(options: LoadContextOptions): Promise<LoadContext>;
+/**
+ * This is the crux of the Docusaurus server-side. It reads everything it needs—
+ * code translations, config file, plugin modules... Plugins then use their
+ * lifecycles to generate content and other data. It is side-effect-ful because
+ * it generates temp files in the `.docusaurus` folder for the bundler.
+ */
+export declare function load(options: LoadContextOptions): Promise<Props>;

package/lib/server/index.js

@@ -6,185 +6,120 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.load = exports.loadPluginConfigs = exports.loadContext = exports.loadSiteConfig = void 0;
+exports.load = exports.loadContext = void 0;
 const tslib_1 = require("tslib");
+const path_1 = tslib_1.__importDefault(require("path"));
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const utils_1 = require("@docusaurus/utils");
-const path_1 = tslib_1.__importStar(require("path"));
-const chalk_1 = tslib_1.__importDefault(require("chalk"));
-const ssr_html_template_1 = tslib_1.__importDefault(require("../client/templates/ssr.html.template"));
-const constants_1 = require("../constants");
-const client_modules_1 = tslib_1.__importDefault(require("./client-modules"));
-const config_1 = tslib_1.__importDefault(require("./config"));
+const config_1 = require("./config");
+const clientModules_1 = require("./clientModules");
 const plugins_1 = require("./plugins");
-const presets_1 = tslib_1.__importDefault(require("./presets"));
-const routes_1 = tslib_1.__importDefault(require("./routes"));
-const html_tags_1 = require("./html-tags");
-const versions_1 = require("./versions");
-const duplicateRoutes_1 = require("./duplicateRoutes");
+const routes_1 = require("./routes");
+const htmlTags_1 = require("./htmlTags");
+const siteMetadata_1 = require("./siteMetadata");
 const i18n_1 = require("./i18n");
 const translations_1 = require("./translations/translations");
-const lodash_1 = require("lodash");
-async function loadSiteConfig({ siteDir, customConfigFilePath, }) {
-    const siteConfigPathUnresolved = customConfigFilePath !== null && customConfigFilePath !== void 0 ? customConfigFilePath : constants_1.DEFAULT_CONFIG_FILE_NAME;
-    const siteConfigPath = path_1.default.isAbsolute(siteConfigPathUnresolved)
-        ? siteConfigPathUnresolved
-        : path_1.default.resolve(siteDir, siteConfigPathUnresolved);
-    const siteConfig = await config_1.default(siteConfigPath);
-    return { siteConfig, siteConfigPath };
-}
-exports.loadSiteConfig = loadSiteConfig;
-async function loadContext(siteDir, options = {}) {
-    var _a;
-    const { customOutDir, locale, customConfigFilePath } = options;
-    const generatedFilesDir = path_1.default.isAbsolute(constants_1.GENERATED_FILES_DIR_NAME)
-        ? constants_1.GENERATED_FILES_DIR_NAME
-        : path_1.default.resolve(siteDir, constants_1.GENERATED_FILES_DIR_NAME);
-    const { siteConfig: initialSiteConfig, siteConfigPath } = await loadSiteConfig({
+/**
+ * Loading context is the very first step in site building. Its options are
+ * directly acquired from CLI options. It mainly loads `siteConfig` and the i18n
+ * context (which includes code translations). The `LoadContext` will be passed
+ * to plugin constructors.
+ */
+async function loadContext(options) {
+    const { siteDir, outDir: baseOutDir = utils_1.DEFAULT_BUILD_DIR_NAME, locale, config: customConfigFilePath, } = options;
+    const generatedFilesDir = path_1.default.resolve(siteDir, utils_1.GENERATED_FILES_DIR_NAME);
+    const { siteConfig: initialSiteConfig, siteConfigPath } = await (0, config_1.loadSiteConfig)({
         siteDir,
         customConfigFilePath,
     });
-    const { ssrTemplate } = initialSiteConfig;
-    const baseOutDir = customOutDir
-        ? path_1.default.resolve(customOutDir)
-        : path_1.default.resolve(siteDir, constants_1.DEFAULT_BUILD_DIR_NAME);
-    const i18n = await i18n_1.loadI18n(initialSiteConfig, { locale });
-    const baseUrl = i18n_1.localizePath({
+    const i18n = await (0, i18n_1.loadI18n)(initialSiteConfig, { locale });
+    const baseUrl = (0, utils_1.localizePath)({
         path: initialSiteConfig.baseUrl,
         i18n,
         options,
         pathType: 'url',
     });
-    const outDir = i18n_1.localizePath({
-        path: baseOutDir,
+    const outDir = (0, utils_1.localizePath)({
+        path: path_1.default.resolve(siteDir, baseOutDir),
         i18n,
         options,
         pathType: 'fs',
     });
     const siteConfig = { ...initialSiteConfig, baseUrl };
-    const codeTranslationFileContent = (_a = (await translations_1.readCodeTranslationFileContent({
-        siteDir,
-        locale: i18n.currentLocale,
-    }))) !== null && _a !== void 0 ? _a : {};
+    const localizationDir = path_1.default.resolve(siteDir, i18n.path, i18n.localeConfigs[i18n.currentLocale].path);
+    const codeTranslationFileContent = (await (0, translations_1.readCodeTranslationFileContent)({ localizationDir })) ?? {};
     // We only need key->message for code translations
-    const codeTranslations = lodash_1.mapValues(codeTranslationFileContent, (value) => value.message);
+    const codeTranslations = lodash_1.default.mapValues(codeTranslationFileContent, (value) => value.message);
     return {
         siteDir,
         generatedFilesDir,
+        localizationDir,
         siteConfig,
         siteConfigPath,
         outDir,
         baseUrl,
         i18n,
-        ssrTemplate,
         codeTranslations,
     };
 }
 exports.loadContext = loadContext;
-function loadPluginConfigs(context) {
-    const { plugins: presetPlugins, themes: presetThemes } = presets_1.default(context);
-    const { siteConfig } = context;
-    return [
-        ...presetPlugins,
-        ...presetThemes,
-        // Site config should be the highest priority.
-        ...(siteConfig.plugins || []),
-        ...(siteConfig.themes || []),
-    ];
-}
-exports.loadPluginConfigs = loadPluginConfigs;
-async function load(siteDir, options = {}) {
-    // Context.
-    const context = await loadContext(siteDir, options);
-    const { generatedFilesDir, siteConfig, siteConfigPath, outDir, baseUrl, i18n, ssrTemplate, codeTranslations, } = context;
-    // Plugins.
-    const pluginConfigs = loadPluginConfigs(context);
-    const { plugins, pluginsRouteConfigs, globalData, themeConfigTranslated, } = await plugins_1.loadPlugins({
-        pluginConfigs,
-        context,
-    });
-    // Side-effect to replace the untranslated themeConfig by the translated one
-    context.siteConfig.themeConfig = themeConfigTranslated;
-    duplicateRoutes_1.handleDuplicateRoutes(pluginsRouteConfigs, siteConfig.onDuplicateRoutes);
-    // Site config must be generated after plugins
-    // We want the generated config to have been normalized by the plugins!
-    const genSiteConfig = utils_1.generate(generatedFilesDir, constants_1.DEFAULT_CONFIG_FILE_NAME, `export default ${JSON.stringify(siteConfig, null, 2)};`);
-    // Make a fake plugin to:
-    // - Resolve aliased theme components
-    // - Inject scripts/stylesheets
-    const { stylesheets = [], scripts = [], clientModules: siteConfigClientModules = [], } = siteConfig;
-    plugins.push({
-        name: 'docusaurus-bootstrap-plugin',
-        content: null,
-        options: {},
-        version: { type: 'synthetic' },
-        getClientModules() {
-            return siteConfigClientModules;
-        },
-        injectHtmlTags: () => {
-            const stylesheetsTags = stylesheets.map((source) => typeof source === 'string'
-                ? `<link rel="stylesheet" href="${source}">`
-                : {
-                    tagName: 'link',
-                    attributes: {
-                        rel: 'stylesheet',
-                        ...source,
-                    },
-                });
-            const scriptsTags = scripts.map((source) => typeof source === 'string'
-                ? `<script src="${source}"></script>`
-                : {
-                    tagName: 'script',
-                    attributes: {
-                        ...source,
-                    },
-                });
-            return {
-                headTags: [...stylesheetsTags, ...scriptsTags],
-            };
-        },
-    });
-    // Load client modules.
-    const clientModules = client_modules_1.default(plugins);
-    const genClientModules = utils_1.generate(generatedFilesDir, 'client-modules.js', `export default [\n${clientModules
-        // import() is async so we use require() because client modules can have
-        // CSS and the order matters for loading CSS.
-        // We need to JSON.stringify so that if its on windows, backslash are escaped.
-        .map((module) => `  require(${JSON.stringify(module)}),`)
-        .join('\n')}\n];\n`);
-    // Load extra head & body html tags.
-    const { headTags, preBodyTags, postBodyTags } = html_tags_1.loadHtmlTags(plugins);
-    // Routing.
-    const { registry, routesChunkNames, routesConfig, routesPaths, } = await routes_1.default(pluginsRouteConfigs, baseUrl);
-    const genRegistry = utils_1.generate(generatedFilesDir, 'registry.js', `export default {
-${Object.keys(registry)
-        .sort()
-        .map((key) => 
-    // We need to JSON.stringify so that if its on windows, backslash are escaped.
-    `  '${key}': [${registry[key].loader}, ${JSON.stringify(registry[key].modulePath)}, require.resolveWeak(${JSON.stringify(registry[key].modulePath)})],`)
-        .join('\n')}};\n`);
-    const genRoutesChunkNames = utils_1.generate(generatedFilesDir, 'routesChunkNames.json', JSON.stringify(routesChunkNames, null, 2));
-    const genRoutes = utils_1.generate(generatedFilesDir, 'routes.js', routesConfig);
-    const genGlobalData = utils_1.generate(generatedFilesDir, 'globalData.json', JSON.stringify(globalData, null, 2));
-    const genI18n = utils_1.generate(generatedFilesDir, 'i18n.json', JSON.stringify(i18n, null, 2));
-    const codeTranslationsWithFallbacks = {
-        ...(await translations_1.getPluginsDefaultCodeTranslationMessages(plugins)),
-        ...codeTranslations,
-    };
-    const genCodeTranslations = utils_1.generate(generatedFilesDir, 'codeTranslations.json', JSON.stringify(codeTranslationsWithFallbacks, null, 2));
-    // Version metadata.
-    const siteMetadata = {
-        docusaurusVersion: versions_1.getPackageJsonVersion(path_1.join(__dirname, '../../package.json')),
-        siteVersion: versions_1.getPackageJsonVersion(path_1.join(siteDir, 'package.json')),
-        pluginVersions: {},
+/**
+ * This is the crux of the Docusaurus server-side. It reads everything it needs—
+ * code translations, config file, plugin modules... Plugins then use their
+ * lifecycles to generate content and other data. It is side-effect-ful because
+ * it generates temp files in the `.docusaurus` folder for the bundler.
+ */
+async function load(options) {
+    const { siteDir } = options;
+    const context = await loadContext(options);
+    const { generatedFilesDir, siteConfig, siteConfigPath, outDir, baseUrl, i18n, localizationDir, codeTranslations: siteCodeTranslations, } = context;
+    const { plugins, pluginsRouteConfigs, globalData } = await (0, plugins_1.loadPlugins)(context);
+    const clientModules = (0, clientModules_1.loadClientModules)(plugins);
+    const { headTags, preBodyTags, postBodyTags } = (0, htmlTags_1.loadHtmlTags)(plugins);
+    const { registry, routesChunkNames, routesConfig, routesPaths } = (0, routes_1.loadRoutes)(pluginsRouteConfigs, baseUrl, siteConfig.onDuplicateRoutes);
+    const codeTranslations = {
+        ...(await (0, translations_1.getPluginsDefaultCodeTranslationMessages)(plugins)),
+        ...siteCodeTranslations,
     };
-    plugins
-        .filter(({ version: { type } }) => type !== 'synthetic')
-        .forEach(({ name, version }) => {
-        siteMetadata.pluginVersions[name] = version;
-    });
-    checkDocusaurusPackagesVersion(siteMetadata);
-    const genSiteMetadata = utils_1.generate(generatedFilesDir, 'site-metadata.json', JSON.stringify(siteMetadata, null, 2));
+    const siteMetadata = await (0, siteMetadata_1.loadSiteMetadata)({ plugins, siteDir });
+    // === Side-effects part ===
+    const genWarning = (0, utils_1.generate)(generatedFilesDir, 
+    // cSpell:ignore DONT
+    'DONT-EDIT-THIS-FOLDER', `This folder stores temp files that Docusaurus' client bundler accesses.
+
+DO NOT hand-modify files in this folder because they will be overwritten in the
+next build. You can clear all build artifacts (including this folder) with the
+\`docusaurus clear\` command.
+`);
+    const genSiteConfig = (0, utils_1.generate)(generatedFilesDir, `${utils_1.DEFAULT_CONFIG_FILE_NAME}.mjs`, `/*
+ * AUTOGENERATED - DON'T EDIT
+ * Your edits in this file will be overwritten in the next build!
+ * Modify the docusaurus.config.js file at your site's root instead.
+ */
+export default ${JSON.stringify(siteConfig, null, 2)};
+`);
+    const genClientModules = (0, utils_1.generate)(generatedFilesDir, 'client-modules.js', `export default [
+${clientModules
+        // Use `require()` because `import()` is async but client modules can have CSS
+        // and the order matters for loading CSS.
+        .map((clientModule) => `  require('${(0, utils_1.escapePath)(clientModule)}'),`)
+        .join('\n')}
+];
+`);
+    const genRegistry = (0, utils_1.generate)(generatedFilesDir, 'registry.js', `export default {
+${Object.entries(registry)
+        .sort((a, b) => a[0].localeCompare(b[0]))
+        .map(([chunkName, modulePath]) => `  '${chunkName}': [() => import(/* webpackChunkName: '${chunkName}' */ '${modulePath}'), '${modulePath}', require.resolveWeak('${modulePath}')],`)
+        .join('\n')}};
+`);
+    const genRoutesChunkNames = (0, utils_1.generate)(generatedFilesDir, 'routesChunkNames.json', JSON.stringify(routesChunkNames, null, 2));
+    const genRoutes = (0, utils_1.generate)(generatedFilesDir, 'routes.js', routesConfig);
+    const genGlobalData = (0, utils_1.generate)(generatedFilesDir, 'globalData.json', JSON.stringify(globalData, null, 2));
+    const genI18n = (0, utils_1.generate)(generatedFilesDir, 'i18n.json', JSON.stringify(i18n, null, 2));
+    const genCodeTranslations = (0, utils_1.generate)(generatedFilesDir, 'codeTranslations.json', JSON.stringify(codeTranslations, null, 2));
+    const genSiteMetadata = (0, utils_1.generate)(generatedFilesDir, 'site-metadata.json', JSON.stringify(siteMetadata, null, 2));
     await Promise.all([
+        genWarning,
         genClientModules,
         genSiteConfig,
         genRegistry,
@@ -195,7 +130,7 @@ ${Object.keys(registry)
         genI18n,
         genCodeTranslations,
     ]);
-    const props = {
+    return {
         siteConfig,
         siteConfigPath,
         siteMetadata,
@@ -203,6 +138,7 @@ ${Object.keys(registry)
         outDir,
         baseUrl,
         i18n,
+        localizationDir,
         generatedFilesDir,
         routes: pluginsRouteConfigs,
         routesPaths,
@@ -210,25 +146,7 @@ ${Object.keys(registry)
         headTags,
         preBodyTags,
         postBodyTags,
-        ssrTemplate: ssrTemplate || ssr_html_template_1.default,
         codeTranslations,
     };
-    return props;
 }
 exports.load = load;
-// We want all @docusaurus/* packages  to have the exact same version!
-// See https://github.com/facebook/docusaurus/issues/3371
-// See https://github.com/facebook/docusaurus/pull/3386
-function checkDocusaurusPackagesVersion(siteMetadata) {
-    const { docusaurusVersion } = siteMetadata;
-    Object.entries(siteMetadata.pluginVersions).forEach(([plugin, versionInfo]) => {
-        var _a;
-        if (versionInfo.type === 'package' &&
-            ((_a = versionInfo.name) === null || _a === void 0 ? void 0 : _a.startsWith('@docusaurus/')) &&
-            versionInfo.version !== docusaurusVersion) {
-            // should we throw instead?
-            // It still could work with different versions
-            console.warn(chalk_1.default.red(`Invalid ${plugin} version ${versionInfo.version}.\nAll official @docusaurus/* packages should have the exact same version as @docusaurus/core (${docusaurusVersion}).\nMaybe you want to check, or regenerate your yarn.lock or package-lock.json file?`));
-        }
-    });
-}

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

@@ -0,0 +1,51 @@
+/**
+ * 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 { LoadContext, PluginModule, PluginOptions } from '@docusaurus/types';
+declare type ImportedPluginModule = PluginModule & {
+    default?: PluginModule;
+};
+export declare type NormalizedPluginConfig = {
+    /**
+     * The default export of the plugin module, or alternatively, what's provided
+     * in the config file as inline plugins. Note that if a file is like:
+     *
+     * ```ts
+     * export default plugin() {...}
+     * export validateOptions() {...}
+     * ```
+     *
+     * Then the static methods may not exist here. `pluginModule.module` will
+     * always take priority.
+     */
+    plugin: PluginModule;
+    /** Options as they are provided in the config, not validated yet. */
+    options: PluginOptions;
+    /** Only available when a string is provided in config. */
+    pluginModule?: {
+        /**
+         * Raw module name as provided in the config. Shorthands have been resolved,
+         * so at least it's directly `require.resolve`able.
+         */
+        path: string;
+        /** Whatever gets imported with `require`. */
+        module: ImportedPluginModule;
+    };
+    /**
+     * Different from `pluginModule.path`, this one is always an absolute path,
+     * used to resolve relative paths returned from lifecycles. If it's an inline
+     * plugin, it will be path to the config file.
+     */
+    entryPath: string;
+};
+/**
+ * Reads the site config's `presets`, `themes`, and `plugins`, imports them, and
+ * normalizes the return value. Plugin configs are ordered, mostly for theme
+ * alias shadowing. Site themes have the highest priority, and preset plugins
+ * are the lowest.
+ */
+export declare function loadPluginConfigs(context: LoadContext): Promise<NormalizedPluginConfig[]>;
+export {};