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.

Sign up for GitHub

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

Fix to recommend rehype-mdx-code-props #2501

Merged
merged 1 commit into from
Jun 30, 2024
Merged

Fix to recommend rehype-mdx-code-props #2501

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/guides/syntax-highlighting.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,13 +150,13 @@ the format of that meta string is, so it defaults to how markdown handles it:
`meta` is ignored.

But what if you want to access `meta` at runtime?
That’s exactly what the remark plugin
[`remark-mdx-code-meta`][remark-mdx-code-meta] does.
That’s exactly what the rehype plugin
[`rehype-mdx-code-props`][rehype-mdx-code-props] does.
It lets you type JSX attributes in the `meta` part which you can access by
with a component for `pre`.

That plugin, like all remark plugins, can be passed as
[`remarkPlugins` in `ProcessorOptions`][processor-options].
That plugin, like all rehype plugins, can be passed as
[`rehypePlugins` in `ProcessorOptions`][processor-options].
More info on plugins is available in [§ Extending MDX][extend]

[commonmark]: https://spec.commonmark.org/current/
Expand All @@ -167,7 +167,7 @@ More info on plugins is available in [§ Extending MDX][extend]

[react-syntax-highlighter]: https://github.com/react-syntax-highlighter/react-syntax-highlighter

[remark-mdx-code-meta]: https://github.com/remcohaszing/remark-mdx-code-meta
[rehype-mdx-code-props]: https://github.com/remcohaszing/rehype-mdx-code-props

[processor-options]: /packages/mdx/#processoroptions

Expand Down