feat(dev): support overriding components for Markdown elements #7502
+57
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 736ef04 The changes in this PR will be included in the next version bump. This PR includes changesets to release 17 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 |
|
Note that this is to some extent a duplicate of #6354, although I prefer this implementation because it requires less configuration to override components. |
|
I rebased this. Could I get a review please? |
You can use an [MDX provider](https://mdxjs.com/docs/using-mdx/#mdx-provider) to override which React components are used for standard Markdown elements. For example, suppose that for all routes under the `/products` path you want to replace all Markdown links with [`<Link>`](../components/link) components instead of HTML `<a>` elements. Create the following route module `app/routes/products.tsx`: ```tsx filename=app/routes/products.tsx import { MDXProvider } from "@mdx-js/react"; import { Link, Outlet } from "@remix-run/react"; export default function Products() { return ( <MDXProvider components={{ a: ({ children, href, ref, ...props }) => href ? ( <Link to={href} {...props}> {children} </Link> ) : ( <a {...props}>{children}</a> ), }} > <Outlet /> </MDXProvider> ); } ``` Then `app/routes/products.hammers.mdx` might look like this: ```mdx filename=app/routes/products.hammers.mdx If you like our hammers, then you should also check out our [nails](/products/nails)! ```
lpsinger
force-pushed
the
MDXProvider
branch
from
d2be3f8
to
736ef04
Compare
|
Rebased again. Sorry to keep pestering, I know maintainers are busy! Could I get a review please? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
You can use an MDX provider to override which React components are used for standard Markdown elements. For example, suppose that for all routes under the
/productspath you want to replace all Markdown links with<Link>components instead of HTML<a>elements. Create the following route moduleapp/routes/products.tsx:Then
app/routes/products.hammers.mdxmight look like this:Testing Strategy: Modified an existing integration test