Skip to content

Commit 1060fd1

Browse files
committed
Add better docs
1 parent 44f2460 commit 1060fd1

File tree

1 file changed

+18
-20
lines changed

1 file changed

+18
-20
lines changed

readme.md

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ When parsing (`from-markdown`), must be combined with
1616
This utility handles parsing and serializing.
1717
See [`micromark-extension-mdxjs-esm`][extension] for how the syntax works.
1818

19-
You probably should use [`micromark-extension-mdxjs`][mdxjs] with
20-
[`mdast-util-mdx`][mdast-util-mdx] (which includes this package) to support all
21-
of 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

@@ -43,26 +43,26 @@ export var c = ''
4343
d
4444
```
4545

46-
And our script, `example.js`, looks as follows:
46+
And our module, `example.js`, looks as follows:
4747

4848
```js
49-
var fs = require('fs')
50-
var acorn = require('acorn')
51-
var syntax = require('micromark-extension-mdxjs-esm')
52-
var fromMarkdown = require('mdast-util-from-markdown')
53-
var toMarkdown = require('mdast-util-to-markdown')
54-
var mdxjsEsm = require('mdast-util-mdxjs-esm')
55-
56-
var doc = fs.readFileSync('example.mdx')
57-
58-
var tree = fromMarkdown(doc, {
59-
extensions: [syntax({acorn: acorn, addResult: true})],
60-
mdastExtensions: [mdxjsEsm.fromMarkdown]
49+
import fs from 'fs'
50+
import * as acorn from 'acorn'
51+
import {fromMarkdown} from 'mdast-util-from-markdown'
52+
import {toMarkdown} from 'mdast-util-to-markdown'
53+
import mdxjsEsm from 'micromark-extension-mdxjs-esm'
54+
import {mdxjsEsmFromMarkdown, mdxjsEsmToMarkdown} from 'mdast-util-mdxjs-esm'
55+
56+
const doc = fs.readFileSync('example.mdx')
57+
58+
const tree = fromMarkdown(doc, {
59+
extensions: [mdxjsEsm({acorn, addResult: true})],
60+
mdastExtensions: [mdxjsEsmFromMarkdown]
6161
})
6262

6363
console.log(tree)
6464

65-
var out = toMarkdown(tree, {extensions: [mdxjsEsm.toMarkdown]})
65+
const out = toMarkdown(tree, {extensions: [mdxjsEsmToMarkdown]})
6666

6767
console.log(out)
6868
```
@@ -269,8 +269,6 @@ abide by its terms.
269269

270270
[extension]: https://github.com/micromark/micromark-extension-mdxjs-esm
271271

272-
[mdxjs]: https://github.com/micromark/micromark-extension-mdxjs
273-
274272
[mdast-util-mdx]: https://github.com/syntax-tree/mdast-util-mdx
275273

276274
[estree]: https://github.com/estree/estree

0 commit comments

Comments
 (0)