Skip to content

Commit effe57c

Browse files
committed
Add improved docs
1 parent ad68ba8 commit effe57c

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

readme.md

+17-9
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@
2626

2727
## What is this?
2828

29-
This utility can be used to check if a node is said to be [generated][].
29+
This utility can be used to check if a node is said to be
30+
[generated][generated-term].
3031

3132
## When should I use this?
3233

@@ -43,7 +44,7 @@ To display positional info to users, use
4344
## Install
4445

4546
This package is [ESM only][esm].
46-
In Node.js (version 12.20+, 14.14+, 16.0+, 18.0+), install with [npm][]:
47+
In Node.js (version 14.14+ and 16.0+), install with [npm][]:
4748

4849
```sh
4950
npm install unist-util-generated
@@ -52,14 +53,14 @@ npm install unist-util-generated
5253
In Deno with [`esm.sh`][esmsh]:
5354

5455
```js
55-
import {generated} from "https://esm.sh/unist-util-generated@2"
56+
import {generated} from 'https://esm.sh/unist-util-generated@2'
5657
```
5758

5859
In browsers with [`esm.sh`][esmsh]:
5960

6061
```html
6162
<script type="module">
62-
import {generated} from "https://esm.sh/unist-util-generated@2?bundle"
63+
import {generated} from 'https://esm.sh/unist-util-generated@2?bundle'
6364
</script>
6465
```
6566

@@ -79,16 +80,21 @@ generated({
7980

8081
## API
8182

82-
This package exports the identifier `generated`.
83+
This package exports the identifier [`generated`][generated].
8384
There is no default export.
8485

8586
### `generated(node)`
8687

87-
Check if `node` ([`Node`][node]) is *[generated][]*.
88+
Check if `node` is generated.
89+
90+
###### Parameters
91+
92+
* `node` ([`Node`][node])
93+
— node to check
8894

8995
###### Returns
9096

91-
Whether `node` is generated (`boolean`).
97+
Whether `node` is generated (does not have positional info) (`boolean`).
9298

9399
## Types
94100

@@ -99,7 +105,7 @@ It exports no additional types.
99105

100106
Projects maintained by the unified collective are compatible with all maintained
101107
versions of Node.js.
102-
As of now, that is Node.js 12.20+, 14.14+, 16.0+, and 18.0+.
108+
As of now, that is Node.js 14.14+ and 16.0+.
103109
Our projects sometimes work with older versions, but this is not guaranteed.
104110

105111
## Related
@@ -179,8 +185,10 @@ abide by its terms.
179185

180186
[node]: https://github.com/syntax-tree/unist#node
181187

182-
[generated]: https://github.com/syntax-tree/unist#generated
188+
[generated-term]: https://github.com/syntax-tree/unist#generated
183189

184190
[unist-util-position]: https://github.com/syntax-tree/unist-util-position
185191

186192
[unist-util-stringify-position]: https://github.com/syntax-tree/unist-util-stringify-position
193+
194+
[generated]: #generatednode

0 commit comments

Comments
 (0)