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.

When to use this

This package is already included in xdm and mdx-js/mdx (next).

You should probably use micromark-extension-mdx or micromark-extension-mdxjs instead, which combine this package with other MDX features. Alternatively, if you’re using micromark or mdast-util-from-markdown and you don’t want all of MDX, use this package.

Install

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

npm:

npm install micromark-extension-mdx-md

Use

import {micromark} from 'micromark'
import {mdxMd} from 'micromark-extension-mdx-md'

const output = micromark('\ta', {extensions: [mdxMd]})

console.log(output)

Yields:

<p>a</p>

API

This package exports the following identifiers: mdxMd. There is no default export.

mdxMd

An extension for micromark to turn some markdown features (HTML, autolinks, indented code) off (can be passed in extensions).

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
• 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