Skip to content

Commit 71e70ad

Browse files
committed
Refactor to improve readme
1 parent 3b04103 commit 71e70ad

File tree

1 file changed

+7
-12
lines changed

1 file changed

+7
-12
lines changed

readme.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[![Backers][backers-badge]][collective]
99
[![Chat][chat-badge]][chat]
1010

11-
Extensions to parse and serialize JSX between mdast and markdown
11+
Extensions to parse and serialize JSX between mdast and markdown.
1212

1313
## Contents
1414

@@ -42,15 +42,13 @@ For more info on MDX, see [What is MDX?][what-is-mdx]
4242
## When to use this
4343

4444
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.
4746

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
4948
[`mdast-util-mdx`][mdast-util-mdx] instead.
5049

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].
5452

5553
## Install
5654

@@ -386,13 +384,12 @@ that represents the supported nodes.
386384
It also exports `ToMarkdownOptions`, which represents the structure of the
387385
respective options.
388386

389-
It also registers the node types with `@types/mdast`
390-
387+
It also registers the node types with `@types/mdast`.
391388
If you’re working with the syntax tree, make sure to import this plugin
392389
somewhere in your types, as that registers the new node types in the tree.
393390

394391
```js
395-
/** @typedef {import('remark-math')} */
392+
/** @typedef {import('mdast-util-mdx-jsx')} */
396393

397394
import {visit} from 'unist-util-visit'
398395

@@ -483,8 +480,6 @@ abide by its terms.
483480

484481
[mdast]: https://github.com/syntax-tree/mdast
485482

486-
[remark]: https://github.com/remarkjs/remark
487-
488483
[mdast-util-from-markdown]: https://github.com/syntax-tree/mdast-util-from-markdown
489484

490485
[mdast-util-to-markdown]: https://github.com/syntax-tree/mdast-util-to-markdown

0 commit comments

Comments
 (0)