micromark-extension-mdx-md

micromark-extension-mdx-md

micromark extension to turn some markdown features off for MDX.

This package provides the low-level modules for integrating with the micromark tokenizer but has no handling of compiling to HTML.

There is no corresponding mdast utility. But you can use this through either micromark-extension-mdx or micromark-extension-mdxjs with mdast-util-mdx to support all of MDX (or MDX.js). Or, use it through remark-mdx or remark-mdxjs (remark).

Install

npm:

npm install micromark-extension-mdx-md

Use

var mdxMd = require('micromark-extension-mdx-md')

micromark('...', {extensions: [mdxMd]})

API

syntax()

Turn some markdown features (HTML, autolinks, indented code) off for MDX (or MDX.js).

The export of syntax is an extension for the micromark parser (to not tokenize some constructs; can be passed in extensions).

There are no options yet.

Related

• micromark/micromark — the smallest commonmark-compliant markdown parser that exists
• micromark/micromark-extension-mdx — micromark extension to support MDX
• micromark/micromark-extension-mdxjs — micromark extension to support MDX.js
• micromark/micromark-extension-mdx-expression — micromark extension to support MDX (or MDX.js) expressions
• micromark/micromark-extension-mdx-jsx — micromark extension to support MDX (or MDX.js) JSX
• micromark/micromark-extension-mdxjs-esm — micromark extension to support MDX.js import/exports
• syntax-tree/mdast-util-mdx — mdast utility to support MDX (or MDX.js)

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