micromark-extension-mdxjs

micromark extension to support MDX.js

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
micromark-extension-mdxjs
703.0.08 months ago4 years agoMinified + gzip package size for micromark-extension-mdxjs in KB

Readme

micromark-extension-mdxjs
!Buildbuild-badgebuild !Coveragecoverage-badgecoverage !Downloadsdownloads-badgedownloads !Sizesize-badgesize !Sponsorssponsors-badgecollective !Backersbackers-badgecollective !Chatchat-badgechat
micromark extensions to support MDXmdxjs.

Contents

*   [`mdxjs(options?)`](#mdxjsoptions)
*   [`Options`](#options)

What is this?

This package contains an extension that adds support for the syntax enabled by MDXmdxjs to micromarkmicromark. This extension is used inside MDX. It supports export/imports, expressions, JSX, and turns some markdown features off.

When to use this

This project is useful when you want to support MDX.
You can use this extension when you are working with micromarkmicromark.
This package is aware of JavaScript syntax. If you want to be unaware of JavaScript, for example because expressions can include Rust or variables or whatnot, use micromark-extension-mdxmicromark-extension-mdx.
Alternatively, you can also use the underlying syntax extensions separately:
— support MDX expressions
— support MDX JSX
— turn some CommonMark features off
— support MDX export/imports
When you need a syntax tree, combine this package with mdast-util-mdxmdast-util-mdx.
All these packages are used in remark-mdxremark-mdx, which focusses on making it easier to transform content by abstracting these internals away.

Install

This package is ESM onlyesm. In Node.js (version 16+), install with npm:
npm install micromark-extension-mdxjs

In Deno with esm.shesmsh:
import {mdxjs} from 'https://esm.sh/micromark-extension-mdxjs@2'

In browsers with esm.shesmsh:
<script type="module">
  import {mdxjs} from 'https://esm.sh/micromark-extension-mdxjs@2?bundle'
</script>

Use

import {micromark} from 'micromark'
import {mdxjs} from 'micromark-extension-mdxjs'

const output = micromark('import a from "b"\n\na <b /> c {1 + 1} d', {
  extensions: [mdxjs()]
})

console.log(output)

Yields:
<p>a  c  d</p>

…which is useless: go to a syntax tree with mdast-util-from-markdownmdast-util-from-markdown and mdast-util-mdxmdast-util-mdx instead.

API

This package exports the identifier mdxjsapi-mdxjs. There is no default export.
The separate extensions support the development conditiondevelopment. Run node --conditions development module.js to get instrumented dev code. Without this condition, production code is loaded.

mdxjs(options?)

Create an extension for micromark to enable MDX syntax.
Parameters
— configuration; passed to all extensions
Returns
Extension for micromark that can be passed in extensions to enable MDX syntax (Extensionmicromark-extension).

Options

Configuration (TypeScript type).
Type
export type {Options} from 'micromark-extension-mdx-expression'

See Optionsmicromark-extension-mdx-expression-options.

Authoring

For recommendations on how to author MDX, see each corresponding readme:

Syntax

For info on the syntax of these features, see each corresponding readme:

Errors

For info on what errors are thrown, see each corresponding readme:

Types

This package is fully typed with TypeScript. It exports the additional type Optionsapi-options.

Compatibility

Projects maintained by the unified collective are compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, micromark-extension-mdxjs@^2, compatible with Node.js 16.
This package works with micromark version 3 and later.

Security

This package is safe.

Related

— support MDX unaware of JS
— support MDX in mdast
— support MDX syntax in remark

Contribute

See contributing.md in micromark/.githubcontributing for ways to get started. See support.mdsupport for ways to get help.
This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MITlicense © Titus Wormerauthor