remark-mdx
Advanced tools
Package description
The remark-mdx npm package is a plugin for remark, a markdown processor powered by plugins part of the unified collective. It enables MDX syntax in markdown documents processed by remark. MDX is an authorable format that lets you seamlessly write JSX in your markdown documents. This package allows you to parse and serialize MDX files, making it possible to use MDX with the remark ecosystem.
Parsing MDX syntax
This feature allows you to parse strings of MDX and transform them into a markdown abstract syntax tree (AST).
const remark = require('remark');
const remarkMdx = require('remark-mdx');
remark().use(remarkMdx).processSync('<h1>Hello, MDX!</h1>').toString();Serializing MDX
This feature enables you to serialize the markdown AST back into a string of MDX, which can then be saved to a file or processed further.
const remark = require('remark');
const remarkMdx = require('remark-mdx');
const vfile = require('to-vfile');
const file = vfile.readSync('example.mdx');
const result = remark().use(remarkMdx).processSync(file).toString();
console.log(result);Remark is the core library that powers the remark ecosystem, which includes remark-mdx. It is a markdown processor that can be extended with plugins but does not support MDX syntax out of the box.
MDX is a full-fledged JSX-in-markdown implementation that goes beyond what remark-mdx offers by providing a complete ecosystem for working with MDX, including compiling to JavaScript, handling imports, and providing custom components.
Rehype is another processor in the unified collective that works with HTML instead of markdown. It can be used in conjunction with remark-mdx to transform the markdown AST into a rehype (HTML) AST and manipulate it further.
Readme
remark plugin to support MDX (Markdown 💛 JSX).
This isn’t useful on its own, you’ll probably want to do combine it with other plugins or do tree traversal yourself to compile to things!
It’s used in MDXjs.
npm:
npm install remark-mdx
Say we have the following file, example.md:
# Hello, {data.to}
<Body>
{message}
</Body>
Best, {data.from}
And our script, example.js, looks as follows:
var vfile = require('to-vfile')
var report = require('vfile-reporter')
var unified = require('unified')
var parse = require('remark-parse')
var stringify = require('remark-stringify')
var mdx = require('remark-mdx')
unified()
.use(parse, {position: false})
.use(stringify)
.use(mdx)
.use(debug)
.process(vfile.readSync('example.md'), function (err, file) {
if (err) throw err
console.log(String(file))
})
function debug() {
return console.dir
}
Now, running node example yields:
{
type: 'root',
children: [
{
type: 'heading',
depth: 1,
children: [
{type: 'text', value: 'Hello, '},
{type: 'mdxSpanExpression', value: 'data.to'}
]
},
{
type: 'mdxBlockElement',
name: 'Body',
attributes: [],
children: [{type: 'mdxBlockExpression', value: 'message'}]
},
{
type: 'paragraph',
children: [
{type: 'text', value: 'Best, '},
{type: 'mdxSpanExpression', value: 'data.from'}
]
}
]
}
# Hello, {data.to}
<Body>
{
message
}
</Body>
Best, {data.from}
remark().use(mdx[, options])Plugin to add support for MDX.
Use of remark-mdx does not involve rehype (hast) or
user content so there are no openings for cross-site scripting (XSS)
attacks.
remark-breaks
— More breaksremark-footnotes
— Footnotes supportremark-frontmatter
— Frontmatter (yaml, toml, and more) supportremark-github
— References to issues, PRs, comments, users, etcremark-math
— Inline and block mathSee 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, organization, or community you agree to abide by its terms.
FAQs
remark plugin to support MDX syntax
The npm package remark-mdx receives a total of 2,462,366 weekly downloads. As such, remark-mdx popularity was classified as popular.
We found that remark-mdx 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
Ecma TC39 is meeting this week and has moved key ECMAScript proposals forward, advancing Deferred Import Evaluation, Error.isError(), RegExp Escaping, and Promise.try to the next stages.
Security News
Researchers have demonstrated that teams of LLM agents can exploit zero-day vulnerabilities with a 53% success rate, and the costs of using AI to do so are rapidly becoming more affordable than hiring a human penetration tester.
Security News
In an unprecedented surge, May 2024 saw the publication of over 5,000 CVEs, marking a historic milestone in cybersecurity with an average of 164 CVEs per day, nearly double the 2023 daily average.