Skip to content

Commit f32cbeb

Browse files
committed
Refactor docs
1 parent bf2a575 commit f32cbeb

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

readme.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ If your content is not in English, you should configure that utility.
6969
## Install
7070

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

7474
```sh
7575
npm install mdast-util-gfm-footnote
@@ -256,7 +256,7 @@ FootnoteReference includes Association
256256
association.
257257

258258
**FootnoteReference** can be used where
259-
**[static phrasing][dfn-static-phrasing-content]** content is expected.
259+
**[phrasing][dfn-phrasing-content]** content is expected.
260260
It has no content model.
261261

262262
**FootnoteReference** includes the mixin **[Association][dfn-mxn-association]**.
@@ -288,10 +288,10 @@ Yields:
288288
type FlowContentGfm = FootnoteDefinition | FlowContent
289289
```
290290

291-
#### `StaticPhrasingContent` (GFM footnotes)
291+
#### `PhrasingContent` (GFM footnotes)
292292

293293
```idl
294-
type StaticPhrasingContentGfm = FootnoteReference | StaticPhrasingContent
294+
type PhrasingContentGfm = FootnoteReference | PhrasingContent
295295
```
296296

297297
## Types
@@ -304,13 +304,13 @@ exposed from `@types/mdast`.
304304

305305
## Compatibility
306306

307-
Projects maintained by the unified collective are compatible with all maintained
307+
Projects maintained by the unified collective are compatible with maintained
308308
versions of Node.js.
309-
As of now, that is Node.js 14.14+ and 16.0+.
310-
Our projects sometimes work with older versions, but this is not guaranteed.
311309

312-
This plugin works with `mdast-util-from-markdown` version 1+ and
313-
`mdast-util-to-markdown` version 1+.
310+
When we cut a new major release, we drop support for unmaintained versions of
311+
Node.
312+
This means we try to keep the current release line,
313+
`mdast-util-gfm-footnote@^1`, compatible with Node.js 12.
314314

315315
## Related
316316

@@ -350,9 +350,9 @@ abide by its terms.
350350

351351
[downloads]: https://www.npmjs.com/package/mdast-util-gfm-footnote
352352

353-
[size-badge]: https://img.shields.io/bundlephobia/minzip/mdast-util-gfm-footnote.svg
353+
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=mdast-util-gfm-footnote
354354

355-
[size]: https://bundlephobia.com/result?p=mdast-util-gfm-footnote
355+
[size]: https://bundlejs.com/?q=mdast-util-gfm-footnote
356356

357357
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
358358

@@ -420,7 +420,7 @@ abide by its terms.
420420

421421
[dfn-flow-content]: #flowcontent-gfm-footnotes
422422

423-
[dfn-static-phrasing-content]: #staticphrasingcontent-gfm-footnotes
423+
[dfn-phrasing-content]: #phrasingcontent-gfm-footnotes
424424

425425
[dfn-footnote-reference]: #footnotereference
426426

0 commit comments

Comments
 (0)