Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MDX] Support remark and rehype plugins, with defaults #3977

Merged
merged 16 commits into from
Jul 20, 2022

Conversation

bholmesdev
Copy link
Contributor

@bholmesdev bholmesdev commented Jul 19, 2022

Changes

  • Exposes MDX's remarkPlugins and rehypePlugins config options
  • Applies same default plugins as our markdown parser: remark-gfm, remark-smartypants
  • Allow users to preserve our default plugins using { extends: [...] }

Testing

Add integration tests for GH-flavored markdown and applying a custom plugin (remark-toc).

Docs

TODO: readme updates

@changeset-bot
Copy link

changeset-bot bot commented Jul 19, 2022

🦋 Changeset detected

Latest commit: e168675

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 5 packages
Name Type
@astrojs/mdx Minor
@e2e/preact-component Patch
@e2e/react-component Patch
@e2e/solid-component Patch
@e2e/svelte-component Patch

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 github-actions bot added the pkg: integration Related to any renderer integration (scope) label Jul 19, 2022
Copy link
Member

@natemoo-re natemoo-re left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code LGTM, waiting on @sarah11918 for copy edits.

packages/integrations/mdx/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@matthewp matthewp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Copy link
Member

@natemoo-re natemoo-re left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with more markdown => Markdown nits

.changeset/new-coats-cheer.md Outdated Show resolved Hide resolved
packages/integrations/mdx/README.md Outdated Show resolved Hide resolved
packages/integrations/mdx/README.md Outdated Show resolved Hide resolved
@bholmesdev bholmesdev force-pushed the feat/mdx-remark-rehype-plugins branch from bbce057 to e168675 Compare July 20, 2022 15:51
@sarah11918
Copy link
Member

LGTM, @bholmesdev !

@bholmesdev bholmesdev merged commit 19433eb into main Jul 20, 2022
@bholmesdev bholmesdev deleted the feat/mdx-remark-rehype-plugins branch July 20, 2022 18:14
@astrobot-houston astrobot-houston mentioned this pull request Jul 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: integration Related to any renderer integration (scope)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants