Skip to content

Commit 5678f02

Browse files
committed
Add improved docs
1 parent 69f0a8d commit 5678f02

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

readme.md

Lines changed: 9 additions & 6 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-
[hast][] utility to check if a node is [*interactive*][spec].
11+
[hast][] utility to check if a node is [*interactive content*][spec].
1212

1313
## Contents
1414

@@ -38,7 +38,7 @@ looking for!
3838
## Install
3939

4040
This package is [ESM only][esm].
41-
In Node.js (version 12.20+, 14.14+, 16.0+, or 18.0+), install with [npm][]:
41+
In Node.js (version 14.14+ and 16.0+), install with [npm][]:
4242

4343
```sh
4444
npm install hast-util-interactive
@@ -87,16 +87,17 @@ interactive({
8787

8888
## API
8989

90-
This package exports the identifier `interactive`.
90+
This package exports the identifier [`interactive`][interactive].
9191
There is no default export.
9292

9393
### `interactive(node)`
9494

95-
Check if the given value is [*interactive*][spec].
95+
Check if the given value is [*interactive content*][spec].
9696

9797
###### Parameters
9898

99-
* `node` ([`Node`][node], optional) — node to check
99+
* `node` ([`Node`][node], optional)
100+
— node to check
100101

101102
###### Returns
102103

@@ -122,7 +123,7 @@ It exports no additional types.
122123

123124
Projects maintained by the unified collective are compatible with all maintained
124125
versions of Node.js.
125-
As of now, that is Node.js 12.20+, 14.14+, 16.0+, and 18.0+.
126+
As of now, that is Node.js 14.14+ and 16.0+.
126127
Our projects sometimes work with older versions, but this is not guaranteed.
127128

128129
## Security
@@ -234,3 +235,5 @@ abide by its terms.
234235
[spec]: https://html.spec.whatwg.org/multipage/dom.html#interactive-content
235236

236237
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
238+
239+
[interactive]: #interactivenode

0 commit comments

Comments
 (0)