@mdx-js/react
Advanced tools
Package description
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.
Readme
@mdx-js/react
React context for MDX.
This package is a context based components provider for combining React with MDX.
This package is not needed for MDX to work with React. See ¶ MDX provider in § Using MDX for when and how to use an MDX provider.
This package is ESM only:
Node 12+ is needed to use it and it must be imported instead of required.
npm:
npm install @mdx-js/react
yarn:
yarn add @mdx-js/react
import {MDXProvider} from '@mdx-js/react'
import Post from './post.mdx'
// ^-- Assumes an integration is used to compile MDX to JS, such as
// `@mdx-js/esbuild`, `@mdx-js/loader`, `@mdx-js/node-loader`, or
// `@mdx-js/rollup`, and that it is configured with
// `options.providerImportSource: '@mdx-js/react'`.
const components = {
em: props => <i {...props} />
}
<MDXProvider components={components}>
<Post />
</MDXProvider>
Note that you don’t have to use MDXProvider and can pass components
directly:
-<MDXProvider components={components}>
- <Post />
-</MDXProvider>
+<Post components={components} />
See ¶ React in § Getting started for how to get started with MDX and React. See ¶ MDX provider in § Using MDX for how to use an MDX provider.
This package exports the following identifiers: MDXContext, MDXProvider,
useMDXComponents, and withMDXComponents.
There is no default export.
MDXProvider(props?)Provider for MDX context.
propsConfiguration (Object, optional).
props.componentsMapping of names for JSX components to React components
(Record<string, string|Component|Components>, optional).
props.disableParentContextTurn off outer component context (boolean, default: false).
props.childrenChildren (JSX elements, optional).
JSX element.
useMDXComponents(components?)Get current components from the MDX Context.
componentsAdditional components (Components) to use or a function that takes the current
components and filters/merges/changes them ((currentComponents: Components) => Components).
Components.
MDXContext🪦 Deprecated: This export is not recommended for use as it exposes internals which should be hidden. It might be removed in a future major release. Please use
useMDXComponentsto get context based components andMDXProviderto set context based components instead.
The React Context for MDX (React.Context).
withMDXComponents(Component)🪦 Deprecated: This export is not recommended for use. It might be removed in a future major release. Please use
useMDXComponentsto get context based components instead.
Create a HOC of Components which is given the current context based MDX
components.
This package is fully typed with TypeScript.
An additional Components type is exported, which represents the acceptable
configuration for the functions and components from this project.
See § Security on our website for information.
See § Contribute on our website for ways to get started. See § Support for ways to get help.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.
FAQs
React context for MDX
The npm package @mdx-js/react receives a total of 5,350,475 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.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.