Security News
JavaScript Leaders Demand Oracle Release the JavaScript Trademark
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
micromark-extension-gfm-task-list-item
Advanced tools
micromark extension to support GFM task list items
The micromark-extension-gfm-task-list-item package is an extension for micromark that adds support for GitHub Flavored Markdown (GFM) task list items. This allows you to parse and render task lists in markdown documents.
Parse GFM Task List Items
This feature allows you to parse GFM task list items from markdown input. The code sample demonstrates how to use the micromark-extension-gfm-task-list-item extension to parse a markdown string containing task list items.
const micromark = require('micromark');
const gfmTaskListItem = require('micromark-extension-gfm-task-list-item');
const input = '- [ ] Task 1\n- [x] Task 2';
const output = micromark(input, { extensions: [gfmTaskListItem()] });
console.log(output);
Render GFM Task List Items
This feature allows you to render GFM task list items to HTML. The code sample demonstrates how to use the micromark-extension-gfm-task-list-item extension along with its HTML renderer to convert a markdown string containing task list items into HTML.
const micromark = require('micromark');
const gfmTaskListItem = require('micromark-extension-gfm-task-list-item');
const html = require('micromark-extension-gfm-task-list-item/html');
const input = '- [ ] Task 1\n- [x] Task 2';
const output = micromark(input, { extensions: [gfmTaskListItem()], htmlExtensions: [html()] });
console.log(output);
remark-gfm is a plugin for remark that adds support for GitHub Flavored Markdown (GFM), including task lists. It is similar to micromark-extension-gfm-task-list-item but is used within the remark ecosystem, which is another popular markdown processor.
markdown-it-task-lists is a plugin for markdown-it that adds support for GFM task lists. It provides similar functionality to micromark-extension-gfm-task-list-item but is designed to work with the markdown-it parser.
markdown-it-checkbox is another plugin for markdown-it that adds support for checkboxes in markdown, which can be used to create task lists. It offers similar functionality to micromark-extension-gfm-task-list-item but focuses specifically on checkboxes.
micromark extension to support GitHub flavored markdown (GFM) task list items.
This package is a micromark extension to add support for GFM task list items.
It matches how task list items work on github.com
.
In many cases, when working with micromark, you’d want to use
micromark-extension-gfm
instead, which combines
this package with other GFM features.
When working with syntax trees, you’d want to combine this package with
mdast-util-gfm-task-list-item
(or
mdast-util-gfm
when using micromark-extension-gfm
).
These tools are all rather low-level.
In most cases, you’d instead want to use remark-gfm
with
remark.
This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:
npm install micromark-extension-gfm-task-list-item
In Deno with Skypack:
import {gfmTaskListItem, gfmTaskListItemHtml} from 'https://cdn.skypack.dev/micromark-extension-gfm-task-list-item@1?dts'
In browsers with Skypack:
<script type="module">
import {gfmTaskListItem, gfmTaskListItemHtml} from 'https://cdn.skypack.dev/micromark-extension-gfm-task-list-item@1?min'
</script>
import {micromark} from 'micromark'
import {
gfmTaskListItem,
gfmTaskListItemHtml
} from 'micromark-extension-gfm-task-list-item'
const output = micromark('* [x] a\n* [ ] b', {
extensions: [gfmTaskListItem],
htmlExtensions: [gfmTaskListItemHtml]
})
console.log(output)
Yields:
<ul>
<li><input checked="" disabled="" type="checkbox"> a</li>
<li><input disabled="" type="checkbox"> b</li>
</ul>
This package exports the following identifiers: gfmTaskListItem
,
gfmTaskListItemHtml
.
There is no default export.
The export map supports the endorsed
development
condition.
Run node --conditions development module.js
to get instrumented dev code.
Without this condition, production code is loaded.
gfmTaskListItem
An extension for micromark to parse GFM task list items (can be passed in
extensions
).
gfmTaskListItemHtml
An extension to compile them to HTML (can be passed in htmlExtensions
).
This package is fully typed with TypeScript. There are no additional exported types.
This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. It also works in Deno and modern browsers.
This package is safe.
syntax-tree/mdast-util-gfm-task-list-item
— support GFM task list items in mdastsyntax-tree/mdast-util-gfm
— support GFM in mdastremarkjs/remark-gfm
— support GFM in remarkSee contributing.md
in micromark/.github
for ways to get
started.
See support.md
for ways to get help.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.
FAQs
micromark extension to support GFM task list items
The npm package micromark-extension-gfm-task-list-item receives a total of 2,232,365 weekly downloads. As such, micromark-extension-gfm-task-list-item popularity was classified as popular.
We found that micromark-extension-gfm-task-list-item demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.