How to avoid mdx-code-block showing up in TOC?

[andreacfromtheapp]

Hi all,

working on release-plz/release-plz#1607 I have an example.md including some mdx-code-block to render markdown examples and these show up in the TOC.

How can I avoid that and only have the actual examples.md headers in the TOC?

[Josh-Cena]

mdx-code-block probably doesn't do what you think it does. Its job is to be completely transparent as if it wasn't there and the MDX it contains was literally written as MDX. This works around translation softwares that can't parse MDX syntax properly by pretending the MDX is just code. If you want to disable headings in TOC, one semi-hack is to replace them with JSX elements such as <h2>Heading</h2>.

[andreacfromtheapp]

you are most certainly right, I am possibly not using mdx as it is meant to but I needed to process markdown in a code block and it worked. if you checked the examples.md you can see there are two code blocks: one is "raw" markdown and the other one "rendered" to show the result of such config. I tried using md instead but it doesn't render it.

if there is a better way to do that I am open to it 100%

[Josh-Cena]

What you want is:

• Render Markdown
• Render it to pure markup as if it's not actual content (i.e. no TOC, no other structural extraction we may do)

This is not a use case Docusaurus supports out of the box. What I suggested was:

Instead of this:

```mdx-code-block
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
```

Do this:

<h1>Changelog</h1>
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
<h2>[Unreleased]</h2>

Note that this may still be a bad idea since it would break your document outline (i.e. your HTML would not be accessible). You may want to put it into an iframe or use styling to mimic headings instead.

The ability to remove certain headings from the TOC is tracked in #6201. However, one thing is certain: mdx-code-block has nothing to do with your use case and if you are not using translation softwares you can safely remove it without any other effects.

[andreacfromtheapp]

thanks @Josh-Cena , I appreciate your time and support. I will try and see how it goes. :)