|
8 | 8 | [![Backers][backers-badge]][collective]
|
9 | 9 | [![Chat][chat-badge]][chat]
|
10 | 10 |
|
11 |
| -Extensions to parse and serialize JSX between mdast and markdown |
| 11 | +Extensions to parse and serialize JSX between mdast and markdown. |
12 | 12 |
|
13 | 13 | ## Contents
|
14 | 14 |
|
@@ -42,15 +42,13 @@ For more info on MDX, see [What is MDX?][what-is-mdx]
|
42 | 42 | ## When to use this
|
43 | 43 |
|
44 | 44 | These tools are all rather low-level.
|
45 |
| -In most cases, you’d want to use [`remark-mdx`][remark-mdx] with [remark][] |
46 |
| -instead. |
| 45 | +In most cases, you’d want to use [`remark-mdx`][remark-mdx] with remark instead. |
47 | 46 |
|
48 |
| -When you are working with syntax trees, and want all of MDX, use |
| 47 | +When you are working with syntax trees and want all of MDX, use |
49 | 48 | [`mdast-util-mdx`][mdast-util-mdx] instead.
|
50 | 49 |
|
51 |
| -When working with `micromark` (through `mdast-util-from-markdown`), you’d want |
52 |
| -to combine this package with |
53 |
| -[`micromark-extension-mdx-jsx`][micromark-extension-mdx-jsx]. |
| 50 | +When working with `mdast-util-from-markdown`, you’d want to combine this package |
| 51 | +with [`micromark-extension-mdx-jsx`][micromark-extension-mdx-jsx]. |
54 | 52 |
|
55 | 53 | ## Install
|
56 | 54 |
|
@@ -386,13 +384,12 @@ that represents the supported nodes.
|
386 | 384 | It also exports `ToMarkdownOptions`, which represents the structure of the
|
387 | 385 | respective options.
|
388 | 386 |
|
389 |
| -It also registers the node types with `@types/mdast` |
390 |
| - |
| 387 | +It also registers the node types with `@types/mdast`. |
391 | 388 | If you’re working with the syntax tree, make sure to import this plugin
|
392 | 389 | somewhere in your types, as that registers the new node types in the tree.
|
393 | 390 |
|
394 | 391 | ```js
|
395 |
| -/** @typedef {import('remark-math')} */ |
| 392 | +/** @typedef {import('mdast-util-mdx-jsx')} */ |
396 | 393 |
|
397 | 394 | import {visit} from 'unist-util-visit'
|
398 | 395 |
|
@@ -483,8 +480,6 @@ abide by its terms.
|
483 | 480 |
|
484 | 481 | [mdast]: https://github.com/syntax-tree/mdast
|
485 | 482 |
|
486 |
| -[remark]: https://github.com/remarkjs/remark |
487 |
| - |
488 | 483 | [mdast-util-from-markdown]: https://github.com/syntax-tree/mdast-util-from-markdown
|
489 | 484 |
|
490 | 485 | [mdast-util-to-markdown]: https://github.com/syntax-tree/mdast-util-to-markdown
|
|
0 commit comments