Add rehype-mdx-toc to export toc to list of plugins #2622
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Initial checklist
Description of changes
Add a rehype plugin rehype-mdx-toc that allows users to export the table of contents (TOC) data as a named export from an MDX module.
Why another table of contents plugin?
Since MDX supports exporting data from MDX modules, it's much more convinent to export the TOC — so that users can use it whatever they like, just like with remark-mdx-frontmatter.
Simple usage:
With some bundlers — like @mdx-js/esbuild, @mdx-js/rollup, and @mdx-js/loader, we can easily import the TOC data at build time: