@yozora/tokenizer-list-item

@yozora/tokenizer-list-item produce ListItem type nodes. See documentation for details.

Install

• npm

  1npm install --save @yozora/tokenizer-list-item

• yarn

  1yarn add @yozora/tokenizer-list-item

Usage

@yozora/tokenizer-list-item has been integrated into @yozora/parser / @yozora/parser-gfm-ex / @yozora/parser-gfm, so you can use YozoraParser / GfmExParser / GfmParser directly.

Basic Usage

@yozora/tokenizer-list-item cannot be used alone, it needs to be registered in YastParser as a plugin-in before it can be used.

1import { DefaultYastParser } from '@yozora/core-parser'
2import ParagraphTokenizer from '@yozora/tokenizer-paragraph'
3import TextTokenizer from '@yozora/tokenizer-text'
4import ListItemTokenizer from '@yozora/tokenizer-list-item'
5
6const parser = new DefaultYastParser()
7  .useBlockFallbackTokenizer(new ParagraphTokenizer())
8  .useInlineFallbackTokenizer(new TextTokenizer())
9  .useTokenizer(new ListItemTokenizer())
10
11// parse source markdown content
12parser.parse(`
13- a
14- b
15  - c
16  - d
17  - e
18- f
19- g
20
21---
22
23- [ ] This is a TODO item.
24- [-] This is a processing TODO item.
25- [x] This is a finished TODO item.
26
27---
28
291. This is an ordered list item
30
31a. This is an another type of ordered list item
32`)

Use within @yozora/parser

1import YozoraParser from '@yozora/parser'
2
3const parser = new YozoraParser()
4
5// parse source markdown content
6parser.parse(`
7- a
8- b
9  - c
10  - d
11  - e
12- f
13- g
14
15---
16
17- [ ] This is a TODO item.
18- [-] This is a processing TODO item.
19- [x] This is a finished TODO item.
20
21---
22
231. This is an ordered list item
24
25a. This is an another type of ordered list item
26`)

Use with @yozora/parser-gfm

1import GfmParser from '@yozora/parser-gfm'
2
3const parser = new GfmParser()
4
5// parse source markdown content
6parser.parse(`
7- a
8- b
9  - c
10  - d
11  - e
12- f
13- g
14
15---
16
17- [ ] This is a TODO item.
18- [-] This is a processing TODO item.
19- [x] This is a finished TODO item.
20
21---
22
231. This is an ordered list item
24
25a. This is an another type of ordered list item
26`)

Use within @yozora/parser-gfm-ex

1import GfmExParser from '@yozora/parser-gfm-ex'
2
3const parser = new GfmExParser()
4
5// parse source markdown content
6parser.parse(`
7- a
8- b
9  - c
10  - d
11  - e
12- f
13- g
14
15---
16
17- [ ] This is a TODO item.
18- [-] This is a processing TODO item.
19- [x] This is a finished TODO item.
20
21---
22
231. This is an ordered list item
24
25a. This is an another type of ordered list item
26`)

Options

Name	Type	Required	Default
name	string	false	"@yozora/tokenizer-list-item"
priority	number	false	TokenizerPriority.CONTAINING_BLOCK

• name: The unique name of the tokenizer, used to bind the token it generates, to determine the tokenizer that should be called in each life cycle of the token in the entire matching / parsing phase.

• priority: Priority of the tokenizer, determine the order of processing, high priority priority execution. interruptable. In addition, in the match-block stage, a high-priority tokenizer can interrupt the matching process of a low-priority tokenizer.

Related

• @yozora/ast
• @yozora/parser
• @yozora/parser-gfm
• @yozora/parser-gfm-ex
• @yozora/tokenizer-list
• @yozora/react-list
• @yozora/react-list-item
• @yozora/react-markdown
• Live Examples
• ListItem | Yozora AST
• Documentation