@@ -16,10 +16,10 @@ When parsing (`from-markdown`), must be combined with
1616This utility handles parsing and serializing.
1717See [ ` micromark-extension-mdx-jsx ` ] [ extension ] for how the syntax works.
1818
19- You probably should use either [ ` micromark-extension-mdx ` ] [ mdx ] or
20- [ ` micromark-extension-mdxjs ` ] [ mdxjs ] with [ ` mdast-util-mdx ` ] [ mdast-util-mdx ]
21- (which both include this package) to support all of MDX (or MDX.js) .
22- Or use it all through [ ` remark-mdx ` ] [ remark-mdx ] ( ** [ remark ] [ ] ** ) .
19+ ## When to use this
20+
21+ Use [ ` mdast-util-mdx ` ] [ mdast-util-mdx ] if you want all of MDX / MDX.js.
22+ Use this otherwise .
2323
2424## Install
2525
@@ -46,26 +46,26 @@ Say we have an MDX.js file, `example.mdx`:
4646<abbr title = " Hypertext Markup Language" >HTML</abbr > is a lovely language.
4747```
4848
49- And our script , ` example.js ` , looks as follows:
49+ And our module , ` example.js ` , looks as follows:
5050
5151``` js
52- var fs = require ( ' fs' )
53- var acorn = require ( ' acorn' )
54- var syntax = require ( ' micromark-extension-mdx-jsx ' )
55- var fromMarkdown = require ( ' mdast-util-from -markdown' )
56- var toMarkdown = require ( ' mdast-util-to-markdown ' )
57- var mdxJsx = require ( ' mdast-util-mdx-jsx' )
58-
59- var doc = fs .readFileSync (' example.mdx' )
60-
61- var tree = fromMarkdown (doc, {
62- extensions: [syntax ({acorn: acorn, addResult: true })],
63- mdastExtensions: [mdxJsx . fromMarkdown ]
52+ import fs from ' node: fs'
53+ import * as acorn from ' acorn'
54+ import { fromMarkdown } from ' mdast-util-from-markdown '
55+ import { toMarkdown } from ' mdast-util-to -markdown'
56+ import { mdxJsx } from ' micromark-extension-mdx-jsx '
57+ import { mdxJsxFromMarkdown , mdxJsxToMarkdown } from ' mdast-util-mdx-jsx'
58+
59+ const doc = fs .readFileSync (' example.mdx' )
60+
61+ const tree = fromMarkdown (doc, {
62+ extensions: [mdxJsx ({acorn: acorn, addResult: true })],
63+ mdastExtensions: [mdxJsxFromMarkdown ]
6464})
6565
6666console .log (tree)
6767
68- var out = toMarkdown (tree, {extensions: [mdxJsx . toMarkdown ]})
68+ const out = toMarkdown (tree, {extensions: [mdxJsxToMarkdown ]})
6969
7070console .log (out)
7171```
@@ -393,10 +393,6 @@ abide by its terms.
393393
394394[ extension ] : https://github.com/micromark/micromark-extension-mdxjs-esm
395395
396- [ mdx ] : https://github.com/micromark/micromark-extension-mdx
397-
398- [ mdxjs ] : https://github.com/micromark/micromark-extension-mdxjs
399-
400396[ mdast-util-mdx ] : https://github.com/syntax-tree/mdast-util-mdx
401397
402398[ quote ] : https://github.com/syntax-tree/mdast-util-to-markdown#optionsquote
0 commit comments