Skip to content

feat(core): add future.v4.mdx1CompatDisabledByDefault flag #11896

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
slorber merged 7 commits into from
Apr 3, 2026
Merged

feat(core): add future.v4.mdx1CompatDisabledByDefault flag #11896

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0d89657
add future.v4.mdx1CompatDisabledByDefault flag
slorber Apr 3, 2026
a94d460
docs
slorber Apr 3, 2026
a484c0c
update snapshots
slorber Apr 3, 2026
d8d028d
Merge branch 'main' into slorber/future-flag-disable-mdx1Compat
slorber Apr 3, 2026
0debca1
add crowdin comment
slorber Apr 3, 2026
5050fd7
improve tests
slorber Apr 3, 2026
cc993ed
improve tests
slorber Apr 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/docusaurus-types/src/config.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ export type FutureV4Config = {
useCssCascadeLayers: boolean;
siteStorageNamespacing: boolean;
fasterByDefault: boolean;
mdx1CompatDisabledByDefault: boolean;
};

// VCS (Version Control System) info about a given change, e.g., a git commit.
Expand Down
1 change: 1 addition & 0 deletions packages/docusaurus-types/src/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ export {
} from './config';

export {
MDX1CompatOptions,
MarkdownConfig,
MarkdownHooks,
DefaultParseFrontMatter,
Expand Down
10 changes: 10 additions & 0 deletions packages/docusaurus/src/server/__tests__/__snapshots__/config.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ exports[`loadSiteConfig website with .cjs siteConfig 1`] = `
},
"v4": {
"fasterByDefault": false,
"mdx1CompatDisabledByDefault": false,
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
Expand Down Expand Up @@ -114,6 +115,7 @@ exports[`loadSiteConfig website with ts + js config 1`] = `
},
"v4": {
"fasterByDefault": false,
"mdx1CompatDisabledByDefault": false,
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
Expand Down Expand Up @@ -201,6 +203,7 @@ exports[`loadSiteConfig website with valid JS CJS config 1`] = `
},
"v4": {
"fasterByDefault": false,
"mdx1CompatDisabledByDefault": false,
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
Expand Down Expand Up @@ -288,6 +291,7 @@ exports[`loadSiteConfig website with valid JS ESM config 1`] = `
},
"v4": {
"fasterByDefault": false,
"mdx1CompatDisabledByDefault": false,
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
Expand Down Expand Up @@ -375,6 +379,7 @@ exports[`loadSiteConfig website with valid TypeScript CJS config 1`] = `
},
"v4": {
"fasterByDefault": false,
"mdx1CompatDisabledByDefault": false,
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
Expand Down Expand Up @@ -462,6 +467,7 @@ exports[`loadSiteConfig website with valid TypeScript ESM config 1`] = `
},
"v4": {
"fasterByDefault": false,
"mdx1CompatDisabledByDefault": false,
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
Expand Down Expand Up @@ -549,6 +555,7 @@ exports[`loadSiteConfig website with valid async config 1`] = `
},
"v4": {
"fasterByDefault": false,
"mdx1CompatDisabledByDefault": false,
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
Expand Down Expand Up @@ -638,6 +645,7 @@ exports[`loadSiteConfig website with valid async config creator function 1`] = `
},
"v4": {
"fasterByDefault": false,
"mdx1CompatDisabledByDefault": false,
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
Expand Down Expand Up @@ -727,6 +735,7 @@ exports[`loadSiteConfig website with valid config creator function 1`] = `
},
"v4": {
"fasterByDefault": false,
"mdx1CompatDisabledByDefault": false,
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
Expand Down Expand Up @@ -819,6 +828,7 @@ exports[`loadSiteConfig website with valid siteConfig 1`] = `
},
"v4": {
"fasterByDefault": false,
"mdx1CompatDisabledByDefault": false,
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
Expand Down
12 changes: 12 additions & 0 deletions packages/docusaurus/src/server/__tests__/__snapshots__/site.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ exports[`loadSite custom-i18n-site loads site 1`] = `
},
"v4": {
"fasterByDefault": false,
"mdx1CompatDisabledByDefault": false,
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
Expand Down Expand Up @@ -282,6 +283,7 @@ exports[`loadSite simple-site-with-baseUrl loads site - custom config 1`] = `
},
"v4": {
"fasterByDefault": false,
"mdx1CompatDisabledByDefault": false,
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
Expand Down Expand Up @@ -449,6 +451,7 @@ exports[`loadSite simple-site-with-baseUrl loads site - custom outDir 1`] = `
},
"v4": {
"fasterByDefault": false,
"mdx1CompatDisabledByDefault": false,
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
Expand Down Expand Up @@ -616,6 +619,7 @@ exports[`loadSite simple-site-with-baseUrl loads site 1`] = `
},
"v4": {
"fasterByDefault": false,
"mdx1CompatDisabledByDefault": false,
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
Expand Down Expand Up @@ -827,6 +831,7 @@ exports[`loadSite simple-site-with-baseUrl-i18n loads site - locale fr + custom
},
"v4": {
"fasterByDefault": false,
"mdx1CompatDisabledByDefault": false,
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
Expand Down Expand Up @@ -1060,6 +1065,7 @@ exports[`loadSite simple-site-with-baseUrl-i18n loads site - custom outDir 1`] =
},
"v4": {
"fasterByDefault": false,
"mdx1CompatDisabledByDefault": false,
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
Expand Down Expand Up @@ -1293,6 +1299,7 @@ exports[`loadSite simple-site-with-baseUrl-i18n loads site - locale de 1`] = `
},
"v4": {
"fasterByDefault": false,
"mdx1CompatDisabledByDefault": false,
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
Expand Down Expand Up @@ -1526,6 +1533,7 @@ exports[`loadSite simple-site-with-baseUrl-i18n loads site - locale en 1`] = `
},
"v4": {
"fasterByDefault": false,
"mdx1CompatDisabledByDefault": false,
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
Expand Down Expand Up @@ -1759,6 +1767,7 @@ exports[`loadSite simple-site-with-baseUrl-i18n loads site - locale es 1`] = `
},
"v4": {
"fasterByDefault": false,
"mdx1CompatDisabledByDefault": false,
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
Expand Down Expand Up @@ -1992,6 +2001,7 @@ exports[`loadSite simple-site-with-baseUrl-i18n loads site - locale fr 1`] = `
},
"v4": {
"fasterByDefault": false,
"mdx1CompatDisabledByDefault": false,
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
Expand Down Expand Up @@ -2225,6 +2235,7 @@ exports[`loadSite simple-site-with-baseUrl-i18n loads site - locale it 1`] = `
},
"v4": {
"fasterByDefault": false,
"mdx1CompatDisabledByDefault": false,
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
Expand Down Expand Up @@ -2458,6 +2469,7 @@ exports[`loadSite simple-site-with-baseUrl-i18n loads site 1`] = `
},
"v4": {
"fasterByDefault": false,
"mdx1CompatDisabledByDefault": false,
"removeLegacyPostBuildHeadAttribute": false,
"siteStorageNamespacing": false,
"useCssCascadeLayers": false,
Expand Down
63 changes: 63 additions & 0 deletions packages/docusaurus/src/server/__tests__/configValidation.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ describe('normalizeConfig', () => {
useCssCascadeLayers: true,
siteStorageNamespacing: true,
fasterByDefault: true,
mdx1CompatDisabledByDefault: true,
},
faster: {
swcJsLoader: true,
Expand Down Expand Up @@ -513,6 +514,7 @@ describe('markdown', () => {
): MarkdownConfig {
return normalizeConfig({markdown}).markdown;
}

it('accepts undefined object', () => {
expect(normalizeMarkdown(undefined)).toEqual(DEFAULT_CONFIG.markdown);
});
Expand Down Expand Up @@ -1348,6 +1350,7 @@ describe('future', () => {
useCssCascadeLayers: true,
siteStorageNamespacing: true,
fasterByDefault: true,
mdx1CompatDisabledByDefault: true,
},
faster: {
swcJsLoader: true,
Expand Down Expand Up @@ -2566,6 +2569,7 @@ describe('future', () => {
useCssCascadeLayers: true,
siteStorageNamespacing: true,
fasterByDefault: true,
mdx1CompatDisabledByDefault: true,
};
expect(
normalizeConfig({
Expand Down Expand Up @@ -2906,5 +2910,64 @@ describe('future', () => {
`);
});
});

describe('mdx1CompatDisabledByDefault', () => {
function mdx1CompatContaining(mdx1Compat: object) {
return expect.objectContaining({
markdown: expect.objectContaining({mdx1Compat}),
});
}

const MDX1_COMPAT_ALL_TRUE = {
comments: true,
admonitions: true,
headingIds: true,
};

const MDX1_COMPAT_ALL_FALSE = {
comments: false,
admonitions: false,
headingIds: false,
};

it('defaults mdx1Compat to all true when flag is off', () => {
expect(normalizeConfig({})).toEqual(
mdx1CompatContaining(MDX1_COMPAT_ALL_TRUE),
);
});

it('defaults mdx1Compat to all false when flag is on', () => {
expect(
normalizeConfig({
future: {v4: {mdx1CompatDisabledByDefault: true}},
}),
).toEqual(mdx1CompatContaining(MDX1_COMPAT_ALL_FALSE));
});

it('defaults mdx1Compat to all false when v4: true', () => {
expect(
normalizeConfig({
future: {v4: true},
}),
).toEqual(mdx1CompatContaining(MDX1_COMPAT_ALL_FALSE));
});

it('keeps explicit mdx1Compat overrides when flag is on', () => {
expect(
normalizeConfig({
future: {v4: {mdx1CompatDisabledByDefault: true}},
markdown: {
mdx1Compat: {admonitions: true},
},
}),
).toEqual(
mdx1CompatContaining({
comments: false,
admonitions: true,
headingIds: false,
}),
);
});
});
});
});
Loading
Loading