Research
Security News
Kill Switch Hidden in npm Packages Typosquatting Chalk and Chokidar
Socket researchers found several malicious npm packages typosquatting Chalk and Chokidar, targeting Node.js developers with kill switches and data theft.
micromark-extension-mdx-jsx
Advanced tools
The micromark-extension-mdx-jsx package is an extension for micromark that enables parsing and compiling MDX JSX syntax. It allows you to use JSX components within your Markdown files, making it easier to integrate React components and other JSX-based elements into your Markdown content.
JSX Component Parsing
This feature allows you to parse JSX components within your Markdown content. The code sample demonstrates how to use the micromark-extension-mdx-jsx package to parse a simple JSX component and convert it to HTML.
const micromark = require('micromark');
const mdxJsx = require('micromark-extension-mdx-jsx');
const markdown = '<MyComponent prop="value" />';
const html = micromark(markdown, { extensions: [mdxJsx()] });
console.log(html);
Attribute Handling
This feature allows you to handle various types of attributes within JSX components in your Markdown. The code sample shows how to parse a JSX component with multiple attributes, including string and numeric values.
const micromark = require('micromark');
const mdxJsx = require('micromark-extension-mdx-jsx');
const markdown = '<MyComponent prop1="value1" prop2={2} />';
const html = micromark(markdown, { extensions: [mdxJsx()] });
console.log(html);
Nested JSX Components
This feature supports nested JSX components within your Markdown content. The code sample demonstrates how to parse a parent component containing a nested child component.
const micromark = require('micromark');
const mdxJsx = require('micromark-extension-mdx-jsx');
const markdown = '<ParentComponent><ChildComponent /></ParentComponent>';
const html = micromark(markdown, { extensions: [mdxJsx()] });
console.log(html);
remark-mdx is a plugin for the remark processor that enables MDX support. It allows you to write JSX within Markdown files and is part of the unified ecosystem. Compared to micromark-extension-mdx-jsx, remark-mdx is more tightly integrated with the remark processor and offers a broader range of plugins for additional functionality.
micromark extension to support MDX JSX (<Component />
).
This package contains an extension that adds support for the JSX syntax enabled
by MDX to micromark
.
These extensions are used inside MDX.
It mostly matches how JSX works in most places that support it (TypeScript,
Babel, esbuild, SWC, etc).
This package can be made aware or unaware of JavaScript syntax. When unaware, expressions could include Rust or variables or whatnot.
This project is useful when you want to support JSX in markdown.
You can use this extension when you are working with micromark
.
To support all MDX features, use
micromark-extension-mdxjs
instead.
When you need a syntax tree, combine this package with
mdast-util-mdx-jsx
.
All these packages are used in remark-mdx
, which focusses on
making it easier to transform content by abstracting these internals away.
When you are using mdx-js/mdx
, all of this is already included.
This package is ESM only. In Node.js (version 16+), install with npm:
npm install micromark-extension-mdx-jsx
In Deno with esm.sh
:
import {mdxJsx} from 'https://esm.sh/micromark-extension-mdx-jsx@2'
In browsers with esm.sh
:
<script type="module">
import {mdxJsx} from 'https://esm.sh/micromark-extension-mdx-jsx@2?bundle'
</script>
import {micromark} from 'micromark'
import {mdxJsx} from 'micromark-extension-mdx-jsx'
const output = micromark('a <b c d="e" /> f', {extensions: [mdxJsx()]})
console.log(output)
Yields:
<p>a f</p>
…which is useless: go to a syntax tree with
mdast-util-from-markdown
and
mdast-util-mdx-jsx
instead.
This package exports the identifier mdxJsx
.
There is no default export.
The export map supports the development
condition.
Run node --conditions development module.js
to get instrumented dev code.
Without this condition, production code is loaded.
mdxJsx(options?)
Create an extension for micromark
to enable MDX JSX syntax.
options
(Options
, optional)
— configurationExtension for micromark
that can be passed in extensions
to enable MDX
JSX syntax (Extension
).
Options
Configuration (TypeScript type).
acorn
(Acorn
, optional)
— acorn parser to useacornOptions
(AcornOptions
, default:
{ecmaVersion: 2024, locations: true, sourceType: 'module'}
)
— configuration for acorn; all fields except locations
can be setaddResult
(boolean
, default: false
)
— whether to add estree
fields to tokens with results from acornWhen authoring markdown with JSX, keep in mind that MDX is a whitespace sensitive and line-based language, while JavaScript is insensitive to whitespace. This affects how markdown and JSX interleave with eachother in MDX. For more info on how it works, see § Interleaving on the MDX site.
JavaScript comments in JSX are not supported.
Incorrect:
<hi/*comment!*//>
<hello// comment!
/>
Correct:
<hi/>
<hello
/>
A PR that adds support for them would be accepted.
JSX elements or JSX fragments as attribute values are not supported. The reason for this change is that it would be confusing whether markdown would work.
Incorrect:
<welcome name=<>Venus</> />
<welcome name=<span>Pluto</span> />
Correct:
<welcome name='Mars' />
<welcome name={<span>Jupiter</span>} />
>
) and right curly brace (}
)JSX does not allow U+003E GREATER THAN (>
) or U+007D RIGHT CURLY BRACE
(}
) literally in text, they need to be encoded as character references
(or expressions).
There is no good reason for this (some JSX parsers agree with us and don’t
crash either).
Therefore, in MDX, U+003E GREATER THAN (>
) and U+007D RIGHT CURLY BRACE
(}
) are fine literally and don’t need to be encoded.
JSX forms with the following BNF:
mdx_jsx_flow ::= mdx_jsx *space_or_tab [mdx_jsx *space_or_tab]
mdx_jsx_text ::= mdx_jsx
; constraint: markdown whitespace (`space_or_tab | eol`) is NOT
; allowed directly after `<` in order to allow `1 < 3` in markdown.
mdx_jsx ::=
'<' [closing]
[*whitespace name [attributes_after_identifier] [closing]]
*whitespace '>'
attributes_after_identifier ::=
1*whitespace (attributes_boolean | attributes_value) |
*whitespace attributes_expression |
attributes_after_value ::=
*whitespace (attributes_boolean | attributes_expression | attributes_value)
attributes_boolean ::= key [attributes_after_identifier]
; Note: in gnostic mode the value of the expression must instead be a single valid ES spread
; expression
attributes_expression ::= expression [attributes_after_value]
attributes_value ::= key initializer [attributes_after_value]
closing ::= *whitespace '/'
name ::= identifier [local | members]
key ::= identifier [local]
local ::= *whitespace ':' *whitespace identifier
members ::= member *member
member ::= *whitespace '.' *whitespace identifier
identifier ::= identifier_start *identifier_part
initializer ::= *whitespace '=' *whitespace value
value ::= double_quoted | single_quoted | expression
; Note: in gnostic mode the value must instead be a single valid ES expression
expression ::= '{' *(expression_text | expression) '}'
double_quoted ::= '"' *double_quoted_text '"'
single_quoted ::= "'" *single_quoted_text "'"
whitespace ::= es_whitespace
double_quoted_text ::= char - '"'
single_quoted_text ::= char - "'"
expression_text ::= char - '{' - '}'
identifier_start ::= es_identifier_start
identifier_part ::= es_identifier_part | '-'
space_or_tab ::= '\t' | ' '
eol ::= '\n' | '\r' | '\r\n'
; ECMAScript
; See “IdentifierStart”: <https://tc39.es/ecma262/#prod-IdentifierStart>
es_identifier_start ::= ?
; See “IdentifierPart”: <https://tc39.es/ecma262/#prod-IdentifierPart>
es_identifier_part ::= ?
; See “Whitespace”: <https://tc39.es/ecma262/#prod-WhiteSpace>
es_whitespace ::= ?
As the flow construct occurs in flow, like all flow constructs, it must be followed by an eol (line ending) or eof (end of file).
The grammar for JSX in markdown is much stricter than that of HTML in markdown. The primary benefit of this is that tags are parsed into tokens, and thus can be processed. Another, arguable, benefit of this is that it comes with syntax errors: if an author types something that is nonsensical, an error is thrown with information about where it happened, what occurred, and what was expected instead.
This extension supports expressions both aware and unaware to JavaScript (respectively gnostic and agnostic). Depending on whether acorn is passed, either valid JavaScript must be used in expressions, or arbitrary text (such as Rust code or so) can be used.
More on this can be found in
§ Syntax of micromark-extension-mdx-expression
.
In aware (gnostic) mode, expressions are parsed with
micromark-extension-mdx-expression
,
which throws some more errors.
This error occurs for many different reasons if something was opened but not
closed (source: micromark-extension-mdx-jsx
, rule id: unexpected-eof
).
Some examples are:
<
</
<a
<a:
<a.
<a b
<a b:
<a b=
<a b="
<a b='
<a b={
<a/
This error occurs for many different reasons if an unexpected character is seen
(source: micromark-extension-mdx-jsx
, rule id: unexpected-character
).
Some examples are:
<.>
</.>
<a?>
<a:+>
<a./>
<a b!>
<a b:1>
<a b=>
<a/->
This error occurs if a <
was seen in a container which then has lazy content
(source: micromark-extension-mdx-jsx
, rule id: unexpected-lazy
).
For example:
> <a
b>
Many tokens are used:
mdxJsxFlowTag
for the whole JSX tag (<a>
)mdxJsxTextTag
^mdxJsxFlowTagMarker
for the tag markers (<
, >
)mdxJsxTextTagMarker
^mdxJsxFlowTagClosingMarker
for the /
marking a closing tag (</a>
)mdxJsxTextTagClosingMarker
^mdxJsxFlowTagSelfClosingMarker
for the /
marking a self-closing tag
(<a/>
)mdxJsxTextTagSelfClosingMarker
^mdxJsxFlowTagName
for the whole tag name (a:b
in <a:b>
)mdxJsxTextTagName
^mdxJsxFlowTagNamePrimary
for the first name (a
in <a:b>
)mdxJsxTextTagNamePrimary
^mdxJsxFlowTagNameMemberMarker
for the .
marking in members (<a.b>
)mdxJsxTextTagNameMemberMarker
^mdxJsxFlowTagNameMember
for member names (b
in <a:b>
)mdxJsxTextTagNameMember
^mdxJsxFlowTagNamePrefixMarker
for the :
between primary and local
(<a:b>
)mdxJsxTextTagNamePrefixMarker
^mdxJsxFlowTagNameLocal
for the local name (b
in <a:b>
)mdxJsxTextTagNameLocal
^mdxJsxFlowTagExpressionAttribute
for whole expression attributes
(<a {...b}>
)mdxJsxTextTagExpressionAttribute
^mdxJsxFlowTagExpressionAttributeMarker
for {
, }
in expression
attributesmdxJsxTextTagExpressionAttributeMarker
^mdxJsxFlowTagExpressionAttributeValue
for chunks of what’s inside
expression attributesmdxJsxTextTagExpressionAttributeValue
^mdxJsxFlowTagAttribute
for a whole normal attribute (<a b>
)mdxJsxTextTagAttribute
^mdxJsxFlowTagAttributeName
for the whole name of an attribute (b:c
in
<a b:c>
)mdxJsxTextTagAttributeName
^mdxJsxFlowTagAttributeNamePrimary
for the first name of an attribute (b
in <a b:c>
)mdxJsxTextTagAttributeNamePrimary
^mdxJsxFlowTagAttributeNamePrefixMarker
for the :
between primary and
local (<a b:c>
)mdxJsxTextTagAttributeNamePrefixMarker
^mdxJsxFlowTagAttributeNameLocal
for the local name of an attribute (c
in <a b:c>
)mdxJsxTextTagAttributeNameLocal
^mdxJsxFlowTagAttributeInitializerMarker
for the =
between an attribute
name and valuemdxJsxTextTagAttributeInitializerMarker
^mdxJsxFlowTagAttributeValueLiteral
for a string attribute value
(<a b="">
)mdxJsxTextTagAttributeValueLiteral
^mdxJsxFlowTagAttributeValueLiteralMarker
for the quotes around a string
attribute value ("
or '
)mdxJsxTextTagAttributeValueLiteralMarker
^mdxJsxFlowTagAttributeValueLiteralValue
for chunks of what’s inside
string attribute valuesmdxJsxTextTagAttributeValueLiteralValue
^mdxJsxFlowTagAttributeValueExpression
for an expression attribute value
(<a b={1}>
)mdxJsxTextTagAttributeValueExpression
^mdxJsxFlowTagAttributeValueExpressionMarker
for the {
and }
of
expression attribute valuesmdxJsxTextTagAttributeValueExpressionMarker
^mdxJsxFlowTagAttributeValueExpressionValue
for chunks of what’s inside
expression attribute valuesmdxJsxTextTagAttributeValueExpressionValue
^This package is fully typed with TypeScript.
It exports the additional type Options
.
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-mdx-jsx@^2
, compatible with Node.js 16.
This package works with micromark
version 3
and later.
This package is safe.
micromark-extension-mdxjs
— support all MDX syntaxmdast-util-mdx-jsx
— support MDX JSX in mdastremark-mdx
— support all MDX syntax in remarkSee 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.
FAQs
micromark extension to support MDX or MDX.js JSX
The npm package micromark-extension-mdx-jsx receives a total of 1,192,298 weekly downloads. As such, micromark-extension-mdx-jsx popularity was classified as popular.
We found that micromark-extension-mdx-jsx demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers found several malicious npm packages typosquatting Chalk and Chokidar, targeting Node.js developers with kill switches and data theft.
Security News
pnpm 10 blocks lifecycle scripts by default to improve security, addressing supply chain attack risks but sparking debate over compatibility and workflow changes.
Product
Socket now supports uv.lock files to ensure consistent, secure dependency resolution for Python projects and enhance supply chain security.