mdast-util-gfm-task-list-item

WebJar for mdast-util-gfm-task-list-item

License	MIT
GroupId	org.webjars.npm
ArtifactId	mdast-util-gfm-task-list-item
Last Version	0.1.6
Release Date	Apr 16, 2021
Type	jar
Description	mdast-util-gfm-task-list-item WebJar for mdast-util-gfm-task-list-item
Project URL	https://www.webjars.org
Source Code Management	https://github.com/syntax-tree/mdast-util-gfm-task-list-item

Download mdast-util-gfm-task-list-item

Filename	Size
mdast-util-gfm-task-list-item-0.1.6.pom
mdast-util-gfm-task-list-item-0.1.6.jar	7 KB
mdast-util-gfm-task-list-item-0.1.6-sources.jar	22 bytes
mdast-util-gfm-task-list-item-0.1.6-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/mdast-util-gfm-task-list-item/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>mdast-util-gfm-task-list-item</artifactId>
    <version>0.1.6</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/mdast-util-gfm-task-list-item/
implementation 'org.webjars.npm:mdast-util-gfm-task-list-item:0.1.6'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/mdast-util-gfm-task-list-item/
implementation ("org.webjars.npm:mdast-util-gfm-task-list-item:0.1.6")

Apache Buildr

'org.webjars.npm:mdast-util-gfm-task-list-item:jar:0.1.6'

Apache Ivy

<dependency org="org.webjars.npm" name="mdast-util-gfm-task-list-item" rev="0.1.6">
  <artifact name="mdast-util-gfm-task-list-item" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='mdast-util-gfm-task-list-item', version='0.1.6')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "mdast-util-gfm-task-list-item" % "0.1.6"

Leiningen

[org.webjars.npm/mdast-util-gfm-task-list-item "0.1.6"]

Dependencies

compile (1)

Group / Artifact	Type	Version
org.webjars.npm » mdast-util-to-markdown	jar	[0.6.0,0.7)

Project Modules

There are no modules declared in this project.

mdast-util-gfm-task-list-item

Extension for mdast-util-from-markdown and/or mdast-util-to-markdown to support GitHub flavored markdown task list items in mdast. When parsing (from-markdown), must be combined with micromark-extension-gfm-task-list-item.

You probably shouldn’t use this package directly, but instead use remark-gfm with remark.

Install

npm:

npm install mdast-util-gfm-task-list-item

Use

Say we have the following file, example.md:

* [ ] To do
* [x] Done

1. Mixed…
2. [x] …messages

And our script, example.js, looks as follows:

var fs = require('fs')
var fromMarkdown = require('mdast-util-from-markdown')
var toMarkdown = require('mdast-util-to-markdown')
var syntax = require('micromark-extension-gfm-task-list-item')
var taskListItem = require('mdast-util-gfm-task-list-item')

var doc = fs.readFileSync('example.md')

var tree = fromMarkdown(doc, {
  extensions: [syntax],
  mdastExtensions: [taskListItem.fromMarkdown]
})

console.log(tree)

var out = toMarkdown(tree, {extensions: [taskListItem.toMarkdown]})

console.log(out)

Now, running node example yields (positional info removed for the sake of brevity):

{
 type: 'root',
 children: [
   {
     type: 'list',
     ordered: false,
     start: null,
     spread: false,
     children: [
       {
         type: 'listItem',
         spread: false,
         checked: false,
         children: [
           {type: 'paragraph', children: [{type: 'text', value: 'To do'}]}
         ]
       },
       {
         type: 'listItem',
         spread: false,
         checked: true,
         children: [
           {type: 'paragraph', children: [{type: 'text', value: 'Done'}]}
         ]
       }
     ]
   },
   {
     type: 'list',
     ordered: true,
     start: 1,
     spread: false,
     children: [
       {
         type: 'listItem',
         spread: false,
         checked: null,
         children: [
           {type: 'paragraph', children: [{type: 'text', value: 'Mixed…'}]}
         ]
       },
       {
         type: 'listItem',
         spread: false,
         checked: true,
         children: [
           {type: 'paragraph', children: [{type: 'text', value: '…messages'}]}
         ]
       }
     ]
   }
 ]
}

*   [ ] To do
*   [x] Done

1.  Mixed…
2.  [x] …messages

API

taskListItem.fromMarkdown

taskListItem.toMarkdown

Note: the separate extensions are also available at mdast-util-gfm-task-list-item/from-markdown and mdast-util-gfm-task-list-item/to-markdown.

Support task list items. The exports are extensions, respectively for mdast-util-from-markdown and mdast-util-to-markdown.

Related

• remarkjs/remark — markdown processor powered by plugins
• remarkjs/remark-gfm — remark plugin to support GFM
• micromark/micromark — the smallest commonmark-compliant markdown parser that exists
• micromark/micromark-extension-gfm-task-list-item — micromark extension to parse GFM task list items
• syntax-tree/mdast-util-from-markdown — mdast parser using micromark to create mdast from markdown
• syntax-tree/mdast-util-to-markdown — mdast serializer to create markdown from mdast

Contribute

See contributing.md in syntax-tree/.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.

License

MIT © Titus Wormer

🌲🌲🌲🌳🌲🌳🌲🌲🌲🌳🌳🌲🌲🌳🌲🌲🎄🌲🌳🌲🌲🌳🐻🌳🌳🌳🌲🌲🌳🌲🎄🌲🌳🌲🌲🌳🌳🌳

Versions

Version
0.1.6 Apr 16, 2021