@docusaurus/core 3.9.2-canary-6562 → 3.9.2-canary-6568

package/lib/server/configValidation.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { Joi } from '@docusaurus/utils-validation';
-import type { DocusaurusConfig, FasterConfig, FutureConfig, FutureV4Config, I18nConfig, MarkdownConfig, MarkdownHooks, StorageConfig } from '@docusaurus/types';
+import type { DocusaurusConfig, FasterConfig, FutureConfig, FutureV4Config, I18nConfig, MDX1CompatOptions, MarkdownConfig, MarkdownHooks, StorageConfig } from '@docusaurus/types';
 export declare const DEFAULT_I18N_CONFIG: I18nConfig;
 export declare const DEFAULT_STORAGE_CONFIG: StorageConfig;
 export declare const DEFAULT_FASTER_CONFIG: FasterConfig;
@@ -14,6 +14,7 @@ export declare const DEFAULT_FUTURE_V4_CONFIG: FutureV4Config;
 export declare const DEFAULT_FUTURE_V4_CONFIG_TRUE: FutureV4Config;
 export declare const DEFAULT_FUTURE_CONFIG: FutureConfig;
 export declare const DEFAULT_MARKDOWN_HOOKS: MarkdownHooks;
+export declare const DEFAULT_MARKDOWN_MDX1COMPAT: MDX1CompatOptions;
 export declare const DEFAULT_MARKDOWN_CONFIG: MarkdownConfig;
 export declare const DEFAULT_CONFIG: Pick<DocusaurusConfig, 'i18n' | 'storage' | 'future' | 'onBrokenLinks' | 'onBrokenAnchors' | 'onBrokenMarkdownLinks' | 'onDuplicateRoutes' | 'plugins' | 'themes' | 'presets' | 'headTags' | 'stylesheets' | 'scripts' | 'clientModules' | 'customFields' | 'themeConfig' | 'titleDelimiter' | 'noIndex' | 'tagline' | 'baseUrlIssueBanner' | 'staticDirectories' | 'markdown'>;
 export declare const ConfigSchema: Joi.ObjectSchema<DocusaurusConfig>;

package/lib/server/configValidation.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfigSchema = exports.DEFAULT_CONFIG = exports.DEFAULT_MARKDOWN_CONFIG = exports.DEFAULT_MARKDOWN_HOOKS = exports.DEFAULT_FUTURE_CONFIG = exports.DEFAULT_FUTURE_V4_CONFIG_TRUE = exports.DEFAULT_FUTURE_V4_CONFIG = exports.DEFAULT_FASTER_CONFIG_TRUE = exports.DEFAULT_FASTER_CONFIG = exports.DEFAULT_STORAGE_CONFIG = exports.DEFAULT_I18N_CONFIG = void 0;
+exports.ConfigSchema = exports.DEFAULT_CONFIG = exports.DEFAULT_MARKDOWN_CONFIG = exports.DEFAULT_MARKDOWN_MDX1COMPAT = exports.DEFAULT_MARKDOWN_HOOKS = exports.DEFAULT_FUTURE_CONFIG = exports.DEFAULT_FUTURE_V4_CONFIG_TRUE = exports.DEFAULT_FUTURE_V4_CONFIG = exports.DEFAULT_FASTER_CONFIG_TRUE = exports.DEFAULT_FASTER_CONFIG = exports.DEFAULT_STORAGE_CONFIG = exports.DEFAULT_I18N_CONFIG = void 0;
 exports.validateConfig = validateConfig;
 const tslib_1 = require("tslib");
 const utils_1 = require("@docusaurus/utils");
@@ -74,6 +74,7 @@ exports.DEFAULT_FUTURE_V4_CONFIG = {
     useCssCascadeLayers: false,
     siteStorageNamespacing: false,
     fasterByDefault: false,
+    mdx1CompatDisabledByDefault: false,
 };
 // When using the "v4: true" shortcut
 exports.DEFAULT_FUTURE_V4_CONFIG_TRUE = {
@@ -81,6 +82,7 @@ exports.DEFAULT_FUTURE_V4_CONFIG_TRUE = {
     useCssCascadeLayers: true,
     siteStorageNamespacing: true,
     fasterByDefault: true,
+    mdx1CompatDisabledByDefault: true,
 };
 exports.DEFAULT_FUTURE_CONFIG = {
     v4: exports.DEFAULT_FUTURE_V4_CONFIG,
@@ -92,17 +94,21 @@ exports.DEFAULT_MARKDOWN_HOOKS = {
     onBrokenMarkdownLinks: 'warn',
     onBrokenMarkdownImages: 'throw',
 };
+exports.DEFAULT_MARKDOWN_MDX1COMPAT = {
+    comments: true,
+    admonitions: true,
+    headingIds: true,
+};
 exports.DEFAULT_MARKDOWN_CONFIG = {
-    format: 'mdx', // TODO change this to "detect" in Docusaurus v4?
+    // TODO Docusaurus v5: change this to "detect"?
+    //  we probably need stable CommonMark support first
+    //  see https://github.com/facebook/docusaurus/issues/9092
+    format: 'mdx',
     mermaid: false,
     emoji: true,
     preprocessor: undefined,
     parseFrontMatter: utils_1.DEFAULT_PARSE_FRONT_MATTER,
-    mdx1Compat: {
-        comments: true,
-        admonitions: true,
-        headingIds: true,
-    },
+    mdx1Compat: exports.DEFAULT_MARKDOWN_MDX1COMPAT,
     anchors: {
         maintainCase: false,
     },
@@ -225,6 +231,7 @@ const FUTURE_V4_SCHEMA = utils_validation_1.Joi.alternatives()
     useCssCascadeLayers: utils_validation_1.Joi.boolean().default(exports.DEFAULT_FUTURE_V4_CONFIG.useCssCascadeLayers),
     siteStorageNamespacing: utils_validation_1.Joi.boolean().default(exports.DEFAULT_FUTURE_V4_CONFIG.siteStorageNamespacing),
     fasterByDefault: utils_validation_1.Joi.boolean().default(exports.DEFAULT_FUTURE_V4_CONFIG.fasterByDefault),
+    mdx1CompatDisabledByDefault: utils_validation_1.Joi.boolean().default(exports.DEFAULT_FUTURE_V4_CONFIG.mdx1CompatDisabledByDefault),
 }), utils_validation_1.Joi.boolean()
     .required()
     .custom((bool) => bool ? exports.DEFAULT_FUTURE_V4_CONFIG_TRUE : exports.DEFAULT_FUTURE_V4_CONFIG))
@@ -385,11 +392,14 @@ exports.ConfigSchema = utils_validation_1.Joi.object({
             .arity(1)
             .optional()
             .default(() => exports.DEFAULT_CONFIG.markdown.preprocessor),
+        // Individual boolean defaults are not set here on purpose
+        // They are resolved in postProcessDocusaurusConfig based on
+        // the future.v4.mdx1CompatDisabledByDefault flag
         mdx1Compat: utils_validation_1.Joi.object({
-            comments: utils_validation_1.Joi.boolean().default(exports.DEFAULT_CONFIG.markdown.mdx1Compat.comments),
-            admonitions: utils_validation_1.Joi.boolean().default(exports.DEFAULT_CONFIG.markdown.mdx1Compat.admonitions),
-            headingIds: utils_validation_1.Joi.boolean().default(exports.DEFAULT_CONFIG.markdown.mdx1Compat.headingIds),
-        }).default(exports.DEFAULT_CONFIG.markdown.mdx1Compat),
+            comments: utils_validation_1.Joi.boolean(),
+            admonitions: utils_validation_1.Joi.boolean(),
+            headingIds: utils_validation_1.Joi.boolean(),
+        }).default({}),
         remarkRehypeOptions: 
         // add proper external options validation?
         // Not sure if it's a good idea, validation is likely to become stale
@@ -406,13 +416,19 @@ exports.ConfigSchema = utils_validation_1.Joi.object({
                 .try(utils_validation_1.Joi.string().equal('ignore', 'log', 'warn', 'throw'), utils_validation_1.Joi.function())
                 .default(exports.DEFAULT_CONFIG.markdown.hooks.onBrokenMarkdownImages),
         }).default(exports.DEFAULT_CONFIG.markdown.hooks),
-    }).default(exports.DEFAULT_CONFIG.markdown),
+    }).default({
+        ...exports.DEFAULT_CONFIG.markdown,
+        mdx1Compat: {
+        // erased on purpose, filled using postprocessing
+        },
+    }),
 }).messages({
     'docusaurus.configValidationWarning': 'Docusaurus config validation warning. Field {#label}: {#warningMessage}',
 });
 // Expressing this kind of logic in Joi is a pain
 // We also want to decouple logic from Joi: easier to remove it later!
 function postProcessDocusaurusConfig(config) {
+    var _a;
     // Resolve storage.namespace based on the v4 future flag
     // undefined means "not explicitly set by user"
     if (config.storage.namespace === undefined) {
@@ -430,6 +446,13 @@ function postProcessDocusaurusConfig(config) {
             config.future.faster[key] = fasterDefault;
         }
     }
+    // Resolve mdx1Compat config based on the v4.mdx1CompatDisabledByDefault flag
+    // undefined means "not explicitly set by user"
+    const mdx1CompatDefault = !config.future.v4.mdx1CompatDisabledByDefault;
+    const mdx1CompatKeys = Object.keys(exports.DEFAULT_MARKDOWN_MDX1COMPAT);
+    for (const key of mdx1CompatKeys) {
+        (_a = config.markdown.mdx1Compat)[key] ?? (_a[key] = mdx1CompatDefault);
+    }
     if (config.onBrokenMarkdownLinks) {
         logger_1.default.warn `The code=${'siteConfig.onBrokenMarkdownLinks'} config option is deprecated and will be removed in Docusaurus v4.
 Please migrate and move this option to code=${'siteConfig.markdown.hooks.onBrokenMarkdownLinks'} instead.`;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docusaurus/core",
   "description": "Easy to Maintain Open Source Documentation Websites",
-  "version": "3.9.2-canary-6562",
+  "version": "3.9.2-canary-6568",
   "license": "MIT",
   "publishConfig": {
     "access": "public"
@@ -33,13 +33,13 @@
     "url": "https://github.com/facebook/docusaurus/issues"
   },
   "dependencies": {
-    "@docusaurus/babel": "3.9.2-canary-6562",
-    "@docusaurus/bundler": "3.9.2-canary-6562",
-    "@docusaurus/logger": "3.9.2-canary-6562",
-    "@docusaurus/mdx-loader": "3.9.2-canary-6562",
-    "@docusaurus/utils": "3.9.2-canary-6562",
-    "@docusaurus/utils-common": "3.9.2-canary-6562",
-    "@docusaurus/utils-validation": "3.9.2-canary-6562",
+    "@docusaurus/babel": "3.9.2-canary-6568",
+    "@docusaurus/bundler": "3.9.2-canary-6568",
+    "@docusaurus/logger": "3.9.2-canary-6568",
+    "@docusaurus/mdx-loader": "3.9.2-canary-6568",
+    "@docusaurus/utils": "3.9.2-canary-6568",
+    "@docusaurus/utils-common": "3.9.2-canary-6568",
+    "@docusaurus/utils-validation": "3.9.2-canary-6568",
     "boxen": "^6.2.1",
     "chalk": "^4.1.2",
     "chokidar": "^3.5.3",
@@ -77,8 +77,8 @@
     "webpack-merge": "^6.0.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "3.9.2-canary-6562",
-    "@docusaurus/types": "3.9.2-canary-6562",
+    "@docusaurus/module-type-aliases": "3.9.2-canary-6568",
+    "@docusaurus/types": "3.9.2-canary-6568",
     "@total-typescript/shoehorn": "^0.1.2",
     "@types/detect-port": "^1.3.3",
     "@types/react-dom": "^19.2.3",
@@ -102,7 +102,7 @@
     }
   },
   "engines": {
-    "node": ">=20.0"
+    "node": ">=24.14"
   },
-  "gitHead": "aa71dbd941b5e110ad2bc5b4a853a8623c3b89b8"
+  "gitHead": "3ff37c23de6a4f4e0d24bc0d5e938255a78086fb"
 }