[MDX] Add getHeadings + generate anchor links
#4095
Conversation
🦋 Changeset detectedLatest commit: d061b9e The changes in this PR will be included in the next version bump. This PR includes changesets to release 5 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
github-actions
bot
added
the
pkg: integration
| let fixture; | ||
|
|
||
| before(async () => { | ||
| fixture = await loadFixture({ |
There was a problem hiding this comment.
Would you mind adding a suite to test removing the default plugin as well?
Would be great to know CI will catch if we accidentally break that code path later assuming the headings are always added
There was a problem hiding this comment.
Added rehype-plugins fixture to mirror our remark-plugins fixture!
There was a problem hiding this comment.
Thank you for running the anchor leg on the MDX relay @bholmesdev! Left a few README comments but this is heading in the right direction!
|
|
||
| export default { | ||
| integrations: [mdx({ | ||
| rehypePlugins: { extends: [rehypeMinifyHtml] }, |
There was a problem hiding this comment.
Does this syntax also work in markdown.rehypePlugins? I currently do something like this to preserve defaults:
import { DEFAULT_REHYPE_PLUGINS } from '@astrojs/markdown-remark';
export default {
markdown: {
rehypePlugins: [...DEFAULT_REHYPE_PLUGINS, myExtraPlugin()],
},
}I like the extends format, but might be smart to make sure these APIs are consistent?
There was a problem hiding this comment.
It doesn't work yet, no! I introduced extends to workshop a new API. I'll make an issue to update Markdown now that we like it 😁
|
|
||
| export default { | ||
| integrations: [mdx({ | ||
| rehypePlugins: { extends: [rehypeMinifyHtml] }, |
Co-authored-by: Chris Swithinbank <[email protected]>
Co-authored-by: Chris Swithinbank <[email protected]>
…to feat/mdx-get-headings
Changes
ids on all MDX headings via a rehype pluginrehypePluginsconfig optiongetHeadingsto MDX file exportsTesting
Add test for ID generation and
getHeadingswith and without JSX expressionsDocs
Add generated exports to MDX README