Skip to content

Commit c1743e6

Browse files
committedAug 6, 2023
Refactor docs
1 parent 246c313 commit c1743e6

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed
 

Diff for: ‎readme.md

+14-11
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ The plugin [`rehype-raw`][rehype-raw] wraps this utility at a higher-level
6464
## Install
6565

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

6969
```sh
7070
npm install hast-util-raw
@@ -117,7 +117,7 @@ Yields:
117117

118118
## API
119119

120-
This package exports the identifier [`raw`][raw].
120+
This package exports the identifier [`raw`][api-raw].
121121
There is no default export.
122122

123123
### `raw(tree[, options])`
@@ -129,7 +129,7 @@ nodes into actual nodes.
129129

130130
* `tree` ([`Node`][node])
131131
— original hast tree to transform
132-
* `options` ([`Options`][options], optional)
132+
* `options` ([`Options`][api-options], optional)
133133
— configuration
134134

135135
###### Returns
@@ -152,17 +152,20 @@ Configuration (TypeScript type).
152152
## Types
153153

154154
This package is fully typed with [TypeScript][].
155-
It exports the additional type [`Options`][options].
155+
It exports the additional type [`Options`][api-options].
156156

157157
The `Raw` node type is registered by and exposed from
158158
[`mdast-util-to-hast`][mdast-util-to-hast].
159159

160160
## Compatibility
161161

162-
Projects maintained by the unified collective are compatible with all maintained
162+
Projects maintained by the unified collective are compatible with maintained
163163
versions of Node.js.
164-
As of now, that is Node.js 14.14+ and 16.0+.
165-
Our projects sometimes work with older versions, but this is not guaranteed.
164+
165+
When we cut a new major release, we drop support for unmaintained versions of
166+
Node.
167+
This means we try to keep the current release line, `hast-util-raw@^8`,
168+
compatible with Node.js 12.
166169

167170
## Security
168171

@@ -219,9 +222,9 @@ abide by its terms.
219222

220223
[downloads]: https://www.npmjs.com/package/hast-util-raw
221224

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

224-
[size]: https://bundlephobia.com/result?p=hast-util-raw
227+
[size]: https://bundlejs.com/?q=hast-util-raw
225228

226229
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
227230

@@ -269,6 +272,6 @@ abide by its terms.
269272

270273
[parse5]: https://github.com/inikulin/parse5
271274

272-
[raw]: #rawtree-options
275+
[api-raw]: #rawtree-options
273276

274-
[options]: #options
277+
[api-options]: #options

0 commit comments

Comments
 (0)
Please sign in to comment.