Skip to content

Commit 94c2074

Browse files
committed
Refactor docs
1 parent 6bb953a commit 94c2074

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

readme.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ internals away.
6464
## Install
6565

6666
This package is [ESM only][esm].
67-
In Node.js (version 14.14+ and 16.0+), install with [npm][]:
67+
In Node.js (version 16+), install with [npm][]:
6868

6969
```sh
7070
npm install mdast-util-mdx
@@ -88,7 +88,7 @@ In browsers with [`esm.sh`][esmsh]:
8888

8989
Say our document `example.mdx` contains:
9090

91-
```markdown
91+
```mdx
9292
import Box from "place"
9393

9494
Here’s an expression:
@@ -249,7 +249,7 @@ console.log(out)
249249
}
250250
```
251251

252-
```markdown
252+
```mdx
253253
import Box from "place"
254254

255255
Here’s an expression:
@@ -376,10 +376,13 @@ visit(tree, function (node) {
376376

377377
## Compatibility
378378

379-
Projects maintained by the unified collective are compatible with all maintained
379+
Projects maintained by the unified collective are compatible with maintained
380380
versions of Node.js.
381-
As of now, that is Node.js 14.14+ and 16.0+.
382-
Our projects sometimes work with older versions, but this is not guaranteed.
381+
382+
When we cut a new major release, we drop support for unmaintained versions of
383+
Node.
384+
This means we try to keep the current release line, `mdast-util-mdx@^2`,
385+
compatible with Node.js 12.
383386

384387
This utility works with `mdast-util-from-markdown` version 1+ and
385388
`mdast-util-to-markdown` version 1+.
@@ -421,9 +424,9 @@ abide by its terms.
421424

422425
[downloads]: https://www.npmjs.com/package/mdast-util-mdx
423426

424-
[size-badge]: https://img.shields.io/bundlephobia/minzip/mdast-util-mdx.svg
427+
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=mdast-util-mdx
425428

426-
[size]: https://bundlephobia.com/result?p=mdast-util-mdx
429+
[size]: https://bundlejs.com/?q=mdast-util-mdx
427430

428431
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
429432

0 commit comments

Comments
 (0)