[MDX] Support remark-rehype options from Astro Markdown config #5427
Conversation
🦋 Changeset detectedLatest commit: 4151592 The changes in this PR will be included in the next version bump. 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
| @@ -71,6 +71,7 @@ export default function mdx(mdxOptions: MdxOptions = {}): AstroIntegration { | |||
| // Note: disable `.md` (and other alternative extensions for markdown files like `.markdown`) support | |||
| format: 'mdx', | |||
| mdExtensions: [], | |||
| remarkRehypeOptions: config.markdown.remarkRehype, | |||
There was a problem hiding this comment.
I'm noticing this applies remarkRehype in all cases. To stay consistent with remark and rehype plugin configs, we should only apply this when mdxOptions.extendPlugins === 'markdown'. I'd add a check for that here.
There was a problem hiding this comment.
I'd probably add remarkRehype to the MdxOptions as well, in keeping with how we mirror the markdown config for the MDX integration. A couple changes for this:
- Add
remarkRehypeto theMdxOptionstype - Spread
mdxOptions.remarkRehypewithconfig.markdown.remarkRehype, checking thatextendPluginsoption I noted above - Add
remarkRehypeto the MDX README. Feel free to link to our existingremarkRehypedocs for simplicity.
A bit complex I know, and we will simplify these APIs in the future! Just want to make sure we stay consistent with extending Markdown configs into MDX.
There was a problem hiding this comment.
@bholmesdev, thanks for the feedback! See latest commits for an attempt to take care of this.
Three things I'm unsure of:
- Is
remarkRehypeof typeRemarkRehypeorRemarkRehypeOptions? I would assume the latter, but themarkdownoptions assume the former. - Should
mdxOptions.remarkRehypebe extended withconfig.markdown.remarkRehypeor the other way round? - Is the README helpful enough?
There was a problem hiding this comment.
Good questions!
- I'd go with whatever the
markdownoptions assume. If the types don't line up with the MDX config, tryRemarkRehypeOptions! - I think you would spread
config.markdown.remarkRehypefirst,mdxOptions.remarkRehypesecond. So MDX options override Markdown options if there's conflicts - With Sarah's suggestion, you're golden I think
There was a problem hiding this comment.
@bholmesdev, sounds good!
- After finding https://github.com/mdx-js/mdx/blob/aff6de4fad5955b804d51cd109248425d786fb1c/packages/mdx/lib/core.js#L7 I have kept
RemarkRehypeOptions. - Fixed and additional tests added.
- Fixed. Thanks a lot, @sarah11918!
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
Changes
Testing
See #4138 and
test/fixtures/mdx-astro-markdown-remarkRehype/src/pages/index.mdxDocs
/cc @withastro/maintainers-docs for feedback!