Skip to content

Commit b830f22

Browse files
committed
Refactor docs
1 parent 4788dfa commit b830f22

File tree

1 file changed

+28
-22
lines changed

1 file changed

+28
-22
lines changed

readme.md

Lines changed: 28 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ for any [unist][] node.
4545
## Install
4646

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

5050
```sh
5151
npm install hast-util-assert
@@ -83,8 +83,11 @@ assert({type: 'element', properties: {}, children: []})
8383

8484
## API
8585

86-
This package exports the identifiers [`_void`][void], [`assert`][assert],
87-
[`literal`][literal], [`parent`][parent], and [`wrap`][wrap].
86+
This package exports the identifiers [`_void`][api-void],
87+
[`assert`][api-assert],
88+
[`literal`][api-literal],
89+
[`parent`][api-parent], and
90+
[`wrap`][api-wrap].
8891
There is no default export.
8992

9093
### `assert(tree[, parent])`
@@ -109,7 +112,7 @@ Nothing.
109112
###### Throws
110113

111114
When `tree` (or its descendants) is not a hast node
112-
([`AssertionError`][assertionerror]).
115+
([`AssertionError`][api-assertion-error]).
113116

114117
### `parent(tree[, parent])`
115118

@@ -133,7 +136,7 @@ Nothing.
133136
###### Throws
134137

135138
When `tree` is not a parent or its descendants are not nodes
136-
([`AssertionError`][assertionerror])
139+
([`AssertionError`][api-assertion-error])
137140

138141
### `literal(node[, parent])`
139142

@@ -154,7 +157,7 @@ Nothing.
154157

155158
###### Throws
156159

157-
When `node` is not a hast literal ([`AssertionError`][assertionerror]).
160+
When `node` is not a hast literal ([`AssertionError`][api-assertion-error]).
158161

159162
### `_void(node[, parent])`
160163

@@ -166,19 +169,22 @@ Re-exported from [`unist-util-assert`][unist-util-assert-wrap].
166169

167170
### `AssertionError`
168171

169-
Re-exported from [`unist-util-assert`][unist-util-assert-assertionerror].
172+
Re-exported from [`unist-util-assert`][unist-util-assert-assertion-error].
170173

171174
## Types
172175

173176
This package is fully typed with [TypeScript][].
174-
It exports the additional type [`AssertionError`][assertionerror].
177+
It exports the additional type [`AssertionError`][api-assertion-error].
175178

176179
## Compatibility
177180

178-
Projects maintained by the unified collective are compatible with all maintained
181+
Projects maintained by the unified collective are compatible with maintained
179182
versions of Node.js.
180-
As of now, that is Node.js 14.14+ and 16.0+.
181-
Our projects sometimes work with older versions, but this is not guaranteed.
183+
184+
When we cut a new major release, we drop support for unmaintained versions of
185+
Node.
186+
This means we try to keep the current release line, `hast-util-assert@^3`,
187+
compatible with Node.js 12.
182188

183189
## Security
184190

@@ -222,9 +228,9 @@ abide by its terms.
222228

223229
[downloads]: https://www.npmjs.com/package/hast-util-assert
224230

225-
[size-badge]: https://img.shields.io/bundlephobia/minzip/hast-util-assert.svg
231+
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=hast-util-assert
226232

227-
[size]: https://bundlephobia.com/result?p=hast-util-assert
233+
[size]: https://bundlejs.com/?q=hast-util-assert
228234

229235
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
230236

@@ -270,20 +276,20 @@ abide by its terms.
270276

271277
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
272278

273-
[void]: #_voidnode-parent
279+
[unist-util-assert-void]: https://github.com/syntax-tree/unist-util-assert#_voidnode-parent
274280

275-
[assert]: #asserttree-parent
281+
[unist-util-assert-wrap]: https://github.com/syntax-tree/unist-util-assert#wrapfn
276282

277-
[literal]: #literalnode-parent
283+
[unist-util-assert-assertion-error]: https://github.com/syntax-tree/unist-util-assert#assertionerror
278284

279-
[parent]: #parenttree-parent
285+
[api-void]: #_voidnode-parent
280286

281-
[wrap]: #wrapfn
287+
[api-assert]: #asserttree-parent
282288

283-
[assertionerror]: #assertionerror
289+
[api-literal]: #literalnode-parent
284290

285-
[unist-util-assert-void]: https://github.com/syntax-tree/unist-util-assert#_voidnode-parent
291+
[api-parent]: #parenttree-parent
286292

287-
[unist-util-assert-wrap]: https://github.com/syntax-tree/unist-util-assert#wrapfn
293+
[api-wrap]: #wrapfn
288294

289-
[unist-util-assert-assertionerror]: https://github.com/syntax-tree/unist-util-assert#assertionerror
295+
[api-assertion-error]: #assertionerror

0 commit comments

Comments
 (0)