TOC shows comments in headings

[plocket]

Have you read the Contributing Guidelines on issues?

• I have read the Contributing Guidelines on issues.

Prerequisites

• I'm using the latest version of Docusaurus.
• I have tried the npm run clear or yarn clear command.
• I have tried rm -rf node_modules yarn.lock package-lock.json and re-installing packages.
• I have tried creating a repro with https://new.docusaurus.io.
• I have read the console error message carefully (if applicable).

Description

The table of contents menu shows the comments in the heading, well as the text of the other nodes.

There is probably an issue for this already, but I couldn't find it.

Reproducible demo

https://codesandbox.io/p/devbox/intelligent-franklin-s3vldx

Steps to reproduce

1. Make a heading
2. Add either a MDX comment or an html comment
3. See that the comments are correctly invisible in the heading
4. See that the text is visible in the table of contents

Expected behavior

I thought the text of the comment that I put in the heading would be invisible in the table of contents.

Actual behavior

The text of the comments was visible in the table of contents.

Your environment

• Public source code: https://codesandbox.io/p/devbox/intelligent-franklin-s3vldx
• Public site URL: https://codesandbox.io/p/devbox/intelligent-franklin-s3vldx
• Docusaurus version used: 3.2.0
• Environment name and version (e.g. Chrome 89, Node.js 16.4): Chrome 123.0.6312.87, devbox
• Operating system and version (e.g. Ubuntu 20.04.2 LTS): OSX 12.6.6

Self-service

• I'd be willing to fix this bug myself.

[Abdullah-03]

TOC in docusaurus-mdx-loader currently does not parse JSX. Not just comments but any expression is simply just converted to string i.e.

{5 + 5}

becomes "5 + 5".

In the code a comment actually states this as a todo

// TODO This is really a workaround, and not super reliable
// For now we only support serializing tagName, className and content
// Can we implement the TOC with real JSX nodes instead of html strings later?

I tried implementing it but wasn't able to without making the code insecure (eval). If a maintainer can point out how that is achieved for headings within the document I could work towards porting it for the TOC. I wasn't able to find that implementation by myself.

[Josh-Cena]

Calling it a duplicate of #9772