remark-mdx

What is remark-mdx?

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.

What are remark-mdx's main functionalities?

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);

Other packages similar to remark-mdx

remark

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.

rehype

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

@mdx-js/remark-mdx

:warning: This project is currently in alpha

MDX syntax support for remark.

Installation

npm install --save remark-mdx

Contribute

See contributing.md in mdx-js/mdx for ways to get started.

This organisation has a Code of Conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer and John Otander