Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
@mdx-js/react
Advanced tools
The @mdx-js/react package allows you to use MDX (Markdown for the component era) with React. MDX is a syntax that lets you seamlessly use JSX in your markdown documents. You can import components, such as interactive charts or alerts, and export metadata. This makes writing long-form content with React components a breeze.
Embedding JSX in Markdown
Allows embedding JSX directly in your markdown files, enabling the inclusion of React components within the content.
<MDXProvider><MyDocument /></MDXProvider>
Importing and using components in MDX
Enables the import and use of React components directly in MDX files, making it easy to integrate interactive or custom elements in markdown content.
import { Chart } from './components/Chart'
# My MDX document
Here's a chart component in my MDX document:
<Chart />
Using MDXProvider to customize components
Allows customization of standard markdown elements (like headings, paragraphs) with your own React components, providing a way to apply consistent styling or behavior across all markdown content.
import { MDXProvider } from '@mdx-js/react'
import { MyHeading, MyParagraph } from './MyComponents'
const components = {
h1: MyHeading,
p: MyParagraph
}
<MDXProvider components={components}>
<MyDocument />
</MDXProvider>
Similar to @mdx-js/react, remark-react allows you to render markdown as React components. However, it uses the remark parsing library and does not support the direct use of JSX within markdown.
react-markdown is another library that lets you render markdown content as React components. It supports plugins to extend its functionality but, unlike @mdx-js/react, does not allow for the embedding of JSX components directly within the markdown.
markdown-to-jsx compiles markdown into JSX but is more focused on simplicity and performance. It doesn't offer the same level of integration with React components or the ability to import and use components directly in markdown files as @mdx-js/react does.
@mdx-js/react
Map components to HTML elements based on the Markdown syntax. Serves as the React implementation for MDX.
npm:
npm install --save @mdx-js/react
<!-- helloworld.md -->
# Hello, World!
import React from 'react'
import {MDXProvider} from '@mdx-js/react'
import {renderToString} from 'react-dom/server'
import HelloWorld from './helloworld.md'
const H1 = props => <h1 style={{color: 'tomato'}} {...props} />
console.log(
renderToString(
<MDXProvider components={{h1: H1}}>
<HelloWorld />
</MDXProvider>
)
)
Yields:
<h1 style="color:tomato">Hello, world!</h1>
See the Support and Contributing guidelines on the MDX website for ways to (get) help.
This project has a Code of Conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.
MIT © Compositor and Vercel
FAQs
React context for MDX
The npm package @mdx-js/react receives a total of 5,029,988 weekly downloads. As such, @mdx-js/react popularity was classified as popular.
We found that @mdx-js/react demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.