Skip to content

chore(website): disable mdx1Compat.comments on our site #11846

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 1 commit into from
Mar 26, 2026
+10 −17
Merged

chore(website): disable mdx1Compat.comments on our site #11846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 0 additions & 2 deletions website/_dogfooding/_docs tests/tests/links/test-markdown-links.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,6 @@ MDX/HTML comments with invalid file references should not be resolved nor report

{/* [doesNotExist.mdx](doesNotExist.mdx) */}

<!-- [doesNotExist.mdx](doesNotExist.mdx) -->

## Reference-style links

The following should also work:
Expand Down
23 changes: 9 additions & 14 deletions website/_dogfooding/_pages tests/markdown-tests-mdx.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,23 +50,18 @@ import TabItem from '@theme/TabItem';

## Comments

Html comment: <!-- comment -->

Html comment multi-line:

<!--
comment
-->

<!-- prettier-ignore -->
MDX comment: {/* comment */}

MDX comment multi-line:
MDX comment in JSX:

<!-- prettier-ignore -->
{/*
comment
*/}
<>
{/* comment */}
<span>
{/* comment */}
TEST
{/* comment */}
</span>
</>

## Import code block from source code file

Expand Down
2 changes: 1 addition & 1 deletion website/docusaurus.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ export default async function createConfigAsync() {
},
mdx1Compat: {
headingIds: false,
// comments: false,
comments: false,
},
remarkRehypeOptions: {
footnoteLabel: getLocalizedConfigValue('remarkRehypeOptions_footnotes'),
Expand Down
Loading