@@ -65,7 +65,7 @@ That’s done by [`mdast-util-to-hast`][mdast-util-to-hast].
65
65
## Install
66
66
67
67
This package is [ ESM only] [ esm ] .
68
- In Node.js (version 14.14+ and 16.0 +), install with [ npm] [ ] :
68
+ In Node.js (version 16 +), install with [ npm] [ ] :
69
69
70
70
``` sh
71
71
npm install mdast-util-gfm-task-list-item
@@ -101,10 +101,10 @@ Say our document `example.md` contains:
101
101
102
102
``` js
103
103
import fs from ' node:fs/promises'
104
- import {fromMarkdown } from ' mdast-util-from-markdown'
105
- import {toMarkdown } from ' mdast-util-to-markdown'
106
104
import {gfmTaskListItem } from ' micromark-extension-gfm-task-list-item'
105
+ import {fromMarkdown } from ' mdast-util-from-markdown'
107
106
import {gfmTaskListItemFromMarkdown , gfmTaskListItemToMarkdown } from ' mdast-util-gfm-task-list-item'
107
+ import {toMarkdown } from ' mdast-util-to-markdown'
108
108
109
109
const doc = await fs .readFile (' example.md' )
110
110
@@ -189,8 +189,8 @@ console.log(out)
189
189
## API
190
190
191
191
This package exports the identifiers
192
- [ ` gfmTaskListItemFromMarkdown ` ] [ api-gfmtasklistitemfrommarkdown ] and
193
- [ ` gfmTaskListItemToMarkdown ` ] [ api-gfmtasklistitemtomarkdown ] .
192
+ [ ` gfmTaskListItemFromMarkdown ` ] [ api-gfm-task-list-item-from-markdown ] and
193
+ [ ` gfmTaskListItemToMarkdown ` ] [ api-gfm-task-list-item-to-markdown ] .
194
194
There is no default export.
195
195
196
196
### ` gfmTaskListItemFromMarkdown `
@@ -247,13 +247,13 @@ The `ListItem` type of the mdast nodes are exposed from `@types/mdast`.
247
247
248
248
## Compatibility
249
249
250
- Projects maintained by the unified collective are compatible with all maintained
250
+ Projects maintained by the unified collective are compatible with maintained
251
251
versions of Node.js.
252
- As of now, that is Node.js 14.14+ and 16.0+.
253
- Our projects sometimes work with older versions, but this is not guaranteed.
254
252
255
- This plugin works with ` mdast-util-from-markdown ` version 1+ and
256
- ` mdast-util-to-markdown ` version 1+.
253
+ When we cut a new major release, we drop support for unmaintained versions of
254
+ Node.
255
+ This means we try to keep the current release line,
256
+ ` mdast-util-gfm-task-list-item@^1 ` , compatible with Node.js 12.
257
257
258
258
## Related
259
259
@@ -293,9 +293,9 @@ abide by its terms.
293
293
294
294
[ downloads ] : https://www.npmjs.com/package/mdast-util-gfm-task-list-item
295
295
296
- [ size-badge ] : https://img.shields.io/bundlephobia/minzip/ mdast-util-gfm-task-list-item.svg
296
+ [ size-badge ] : https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q= mdast-util-gfm-task-list-item
297
297
298
- [ size ] : https://bundlephobia .com/result?p =mdast-util-gfm-task-list-item
298
+ [ size ] : https://bundlejs .com/?q =mdast-util-gfm-task-list-item
299
299
300
300
[ sponsors-badge ] : https://opencollective.com/unified/sponsors/badge.svg
301
301
@@ -351,6 +351,6 @@ abide by its terms.
351
351
352
352
[ gfm ] : https://github.github.com/gfm/
353
353
354
- [ api-gfmtasklistitemfrommarkdown ] : #gfmtasklistitemfrommarkdown
354
+ [ api-gfm-task-list-item-from-markdown ] : #gfmtasklistitemfrommarkdown
355
355
356
- [ api-gfmtasklistitemtomarkdown ] : #gfmtasklistitemtomarkdown
356
+ [ api-gfm-task-list-item-to-markdown ] : #gfmtasklistitemtomarkdown
0 commit comments