Skip to content

micromark extension to support MDX (agnostic to JavaScript)

License

Notifications You must be signed in to change notification settings

micromark/micromark-extension-mdx

Repository files navigation

micromark-extension-mdx

Build Coverage Downloads Size Sponsors Backers Chat

micromark extension to support MDX (agnostic to JS). Use micromark-extension-mdxjs instead to support MDX.js.

This package provides the low-level modules for integrating with the micromark tokenizer but has no handling of compiling to HTML: go to a syntax tree instead.

You probably should use this package with mdast-util-mdx (mdast) or alternatively use both through remark-mdx (remark).

The extensions can be used separately:

Install

npm:

npm install micromark-extension-mdx

Use

See mdast-util-mdx for an example.

API

syntax(options?)

Support MDX (agnostic to JS).

There are no options yet.

The export is a function that can be called to return an extension for the micromark parser (to tokenize MDX; can be passed in extensions).

Related

Contribute

See contributing.md in micromark/.github for ways to get started. See support.md 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.

License

MIT © Titus Wormer