Skip to content

Commit e5e0857

Browse files
committed
Refactor docs
1 parent ea37304 commit e5e0857

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

readme.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ If your content is not in English, you should configure that utility.
8787
## Install
8888

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

9292
```sh
9393
npm install mdast-util-gfm
@@ -143,10 +143,10 @@ A note[^1]
143143

144144
```js
145145
import fs from 'node:fs/promises'
146-
import {fromMarkdown} from 'mdast-util-from-markdown'
147-
import {toMarkdown} from 'mdast-util-to-markdown'
148146
import {gfm} from 'micromark-extension-gfm'
147+
import {fromMarkdown} from 'mdast-util-from-markdown'
149148
import {gfmFromMarkdown, gfmToMarkdown} from 'mdast-util-gfm'
149+
import {toMarkdown} from 'mdast-util-to-markdown'
150150

151151
const doc = await fs.readFile('example.md')
152152

@@ -389,13 +389,13 @@ and `TableCell` types of the mdast nodes are exposed from `@types/mdast`.
389389

390390
## Compatibility
391391

392-
Projects maintained by the unified collective are compatible with all maintained
392+
Projects maintained by the unified collective are compatible with maintained
393393
versions of Node.js.
394-
As of now, that is Node.js 14.14+ and 16.0+.
395-
Our projects sometimes work with older versions, but this is not guaranteed.
396394

397-
This plugin works with `mdast-util-from-markdown` version 1+ and
398-
`mdast-util-to-markdown` version 1+.
395+
When we cut a new major release, we drop support for unmaintained versions of
396+
Node.
397+
This means we try to keep the current release line, `mdast-util-gfm@^2`,
398+
compatible with Node.js 12.
399399

400400
## Related
401401

@@ -432,9 +432,9 @@ abide by its terms.
432432

433433
[downloads]: https://www.npmjs.com/package/mdast-util-gfm
434434

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

437-
[size]: https://bundlephobia.com/result?p=mdast-util-gfm
437+
[size]: https://bundlejs.com/?q=mdast-util-gfm
438438

439439
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
440440

0 commit comments

Comments
 (0)