Skip to content

Commit d2f17c9

Browse files
committed
Refactor docs
1 parent 422cabe commit d2f17c9

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

readme.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -69,13 +69,14 @@ heading({
6969
heading({
7070
type: 'element',
7171
tagName: 'h1',
72+
properties: {},
7273
children: [{type: 'text', value: 'Delta'}]
7374
}) // => true
7475
```
7576

7677
## API
7778

78-
This package exports the identifier [`heading`][heading].
79+
This package exports the identifier [`heading`][api-heading].
7980
There is no default export.
8081

8182
### `heading(value)`
@@ -101,10 +102,13 @@ It exports no additional types.
101102

102103
## Compatibility
103104

104-
Projects maintained by the unified collective are compatible with all maintained
105+
Projects maintained by the unified collective are compatible with maintained
105106
versions of Node.js.
106-
As of now, that is Node.js 12.20+, 14.14+, 16.0+, and 18.0+.
107-
Our projects sometimes work with older versions, but this is not guaranteed.
107+
108+
When we cut a new major release, we drop support for unmaintained versions of
109+
Node.
110+
This means we try to keep the current release line, `hast-util-heading@^2`,
111+
compatible with Node.js 12.
108112

109113
## Security
110114

@@ -176,9 +180,9 @@ abide by its terms.
176180

177181
[downloads]: https://www.npmjs.com/package/hast-util-heading
178182

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

181-
[size]: https://bundlephobia.com/result?p=hast-util-heading
185+
[size]: https://bundlejs.com/?q=hast-util-heading
182186

183187
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
184188

@@ -218,4 +222,4 @@ abide by its terms.
218222

219223
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
220224

221-
[heading]: #headingvalue
225+
[api-heading]: #headingvalue

0 commit comments

Comments
 (0)