Skip to content

Commit c61c7aa

Browse files
committed
Refactor docs
1 parent cce7bcc commit c61c7aa

File tree

1 file changed

+20
-17
lines changed

1 file changed

+20
-17
lines changed

readme.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ same at a higher-level (easier) abstraction.
4949
## Install
5050

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

5454
```sh
5555
npm install mdast-util-to-nlcst
@@ -80,11 +80,11 @@ Some *foo*sball.
8080
…and next to it a module `example.js`:
8181

8282
```js
83-
import {read} from 'to-vfile'
84-
import {ParseEnglish} from 'parse-english'
85-
import {inspect} from 'unist-util-inspect'
8683
import {fromMarkdown} from 'mdast-util-from-markdown'
8784
import {toNlcst} from 'mdast-util-to-nlcst'
85+
import {ParseEnglish} from 'parse-english'
86+
import {read} from 'to-vfile'
87+
import {inspect} from 'unist-util-inspect'
8888

8989
const file = await read('example.md')
9090
const mdast = fromMarkdown(file)
@@ -110,7 +110,7 @@ RootNode[1] (1:1-1:17, 0-16)
110110

111111
## API
112112

113-
This package exports the identifier [`toNlcst`][api-tonlcst].
113+
This package exports the identifier [`toNlcst`][api-to-nlcst].
114114
There is no default export.
115115

116116
### `toNlcst(tree, file, Parser[, options])`
@@ -126,8 +126,8 @@ Turn an mdast tree into an nlcst tree.
126126
— mdast tree to transform
127127
* `file` ([`VFile`][vfile])
128128
— virtual file
129-
* `Parser` ([`ParserConstructor`][api-parserconstructor] or
130-
[`ParserInstance`][api-parserinstance])
129+
* `Parser` ([`ParserConstructor`][api-parser-constructor] or
130+
[`ParserInstance`][api-parser-instance])
131131
— parser to use
132132
* `options` ([`Options`][api-options], optional)
133133
— configuration
@@ -245,15 +245,18 @@ type ParserInstance = {
245245
246246
This package is fully typed with [TypeScript][].
247247
It exports the types [`Options`][api-options],
248-
[`ParserConstructor`][api-parserconstructor], and
249-
[`ParserInstance`][api-parserinstance].
248+
[`ParserConstructor`][api-parser-constructor], and
249+
[`ParserInstance`][api-parser-instance].
250250
251251
## Compatibility
252252
253-
Projects maintained by the unified collective are compatible with all maintained
253+
Projects maintained by the unified collective are compatible with maintained
254254
versions of Node.js.
255-
As of now, that is Node.js 12.20+, 14.14+, and 16.0+.
256-
Our projects sometimes work with older versions, but this is not guaranteed.
255+
256+
When we cut a new major release, we drop support for unmaintained versions of
257+
Node.
258+
This means we try to keep the current release line, `mdast-util-to-nlcst@^6`,
259+
compatible with Node.js 12.
257260
258261
## Security
259262
@@ -301,9 +304,9 @@ abide by its terms.
301304
302305
[downloads]: https://www.npmjs.com/package/mdast-util-to-nlcst
303306
304-
[size-badge]: https://img.shields.io/bundlephobia/minzip/mdast-util-to-nlcst.svg
307+
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=mdast-util-to-nlcst
305308
306-
[size]: https://bundlephobia.com/result?p=mdast-util-to-nlcst
309+
[size]: https://bundlejs.com/?q=mdast-util-to-nlcst
307310
308311
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
309312
@@ -359,10 +362,10 @@ abide by its terms.
359362
360363
[parse-dutch]: https://github.com/wooorm/parse-dutch
361364
362-
[api-tonlcst]: #tonlcsttree-file-parser-options
365+
[api-to-nlcst]: #tonlcsttree-file-parser-options
363366
364367
[api-options]: #options
365368
366-
[api-parserconstructor]: #parserconstructor
369+
[api-parser-constructor]: #parserconstructor
367370
368-
[api-parserinstance]: #parserinstance
371+
[api-parser-instance]: #parserinstance

0 commit comments

Comments
 (0)