Skip to content

Commit 34d7783

Browse files
committed
Refactor docs
1 parent b6afd5a commit 34d7783

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

readme.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ parse HTML with DOM APIs.
5252
## Install
5353

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

5757
```sh
5858
npm install hast-util-from-dom
@@ -101,7 +101,7 @@ Now running `open example.html` prints the following to the console:
101101

102102
## API
103103

104-
This package exports the identifier [`fromDom`][fromdom].
104+
This package exports the identifier [`fromDom`][api-from-dom].
105105
There is no default export.
106106

107107
### `fromDom(tree, options?)`
@@ -112,7 +112,7 @@ Transform a DOM tree to a hast tree.
112112

113113
* `tree` ([`DomNode`][dom-node])
114114
— DOM tree to transform
115-
* `options` ([`Options`][options], optional)
115+
* `options` ([`Options`][api-options], optional)
116116
— configuration
117117

118118
###### Returns
@@ -140,7 +140,7 @@ Configuration (TypeScript type).
140140

141141
##### Fields
142142

143-
* `afterTransform` ([`AfterTransform`][aftertransform], optional)
143+
* `afterTransform` ([`AfterTransform`][api-after-transform], optional)
144144
— callback called when each node is transformed
145145

146146
##### Returns
@@ -150,14 +150,18 @@ Configuration (TypeScript type).
150150
## Types
151151

152152
This package is fully typed with [TypeScript][].
153-
It exports the additional type `Options`.
153+
It exports the additional types [`AfterTransform`][api-after-transform] and
154+
[`Options`][api-options].
154155

155156
## Compatibility
156157

157-
Projects maintained by the unified collective are compatible with all maintained
158+
Projects maintained by the unified collective are compatible with maintained
158159
versions of Node.js.
159-
As of now, that is Node.js 12.20+, 14.14+, and 16.0+.
160-
Our projects sometimes work with older versions, but this is not guaranteed.
160+
161+
When we cut a new major release, we drop support for unmaintained versions of
162+
Node.
163+
This means we try to keep the current release line, `hast-util-from-dom@^4`,
164+
compatible with Node.js 12.
161165

162166
## Security
163167

@@ -203,9 +207,9 @@ abide by its terms.
203207

204208
[downloads]: https://www.npmjs.com/package/hast-util-from-dom
205209

206-
[size-badge]: https://img.shields.io/bundlephobia/minzip/hast-util-from-dom.svg
210+
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=hast-util-from-dom
207211

208-
[size]: https://bundlephobia.com/result?p=hast-util-from-dom
212+
[size]: https://bundlejs.com/?q=hast-util-from-dom
209213

210214
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
211215

@@ -253,8 +257,8 @@ abide by its terms.
253257

254258
[jsdom]: https://github.com/jsdom/jsdom
255259

256-
[fromdom]: #fromdomtree-options
260+
[api-from-dom]: #fromdomtree-options
257261

258-
[options]: #options
262+
[api-options]: #options
259263

260-
[aftertransform]: #aftertransform
264+
[api-after-transform]: #aftertransform

0 commit comments

Comments
 (0)