Version: 2.x.x

@yozora/parser-gfm-ex

A markdown parser with built-in tokenizers to fully support GFM and GFM extensions.

github flavor markdown spec

See github flavor markdown spec for details.
See GFM Live Examples for an intuitive impression.

Install

npm
Yarn
pnpm

npm install --save @yozora/parser-gfm-ex

yarn add @yozora/parser-gfm-ex

pnpm add @yozora/parser-gfm-ex

Usage

Basic

import GfmExParser from '@yozora/parser-gfm-ex'

const parser = new GfmExParser()

// parse markdown source content.
parser.parse('source markdown content')

// parse markdown source content with custom options.
parser.parse(
  'source markdown content',  // markdown source contents, `string|Iterable<string>`
  {},                         // ParseOptions, optional.
)

// parse multiple markdown source content pieces.
parser.parse(['source', 'contents'])

Use withing generator:

import GfmExParser from '@yozora/parser-gfm-ex'

const parser = new GfmExParser()

/**
 * String stream is supported through the iterator API.
 */
function* source () {
  yield 'hello',
  yield 'world',
}

parser.parse(source())

Options

Constructor Options

Name	Type	Required	Description
`blockFallbackTokenizer`	`BlockFallbackTokenizer`	`false`	Fallback tokenizer on processing block structure phase
`inlineFallbackTokenizer`	`InlineFallbackTokenizer`	`false`	Fallback tokenizer on processing inline structure phase
`defaultParseOptions`	`ParseOptions`	`false`	Default options for `parse()`

ParseOptions

Name	Type	Required	Description
`shouldReservePosition`	`boolean`	`false`	Whether it is necessary to reserve the position in the Node produced
`presetDefinitions`	`Array<Omit<Definition, 'type'>`	`false`	Preset definitions
`presetFootnoteDefinitions`	`Array<Omit<FootnoteDefinition, 'type'>`	`false`	Preset footnote definition

Overview

Built-in tokenizers

Tokenizer	Description
@yozora/tokenizer-autolink	Resolve GFM Autolinks
@yozora/tokenizer-autolink-extension	Resolve GFM Autolinks (extension)
@yozora/tokenizer-blockquote	Resolve GFM blockquotes
@yozora/tokenizer-break	Resolve GFM hard line breaks and GFM soft line breaks
@yozora/tokenizer-definition	Resolve GFM link reference definitions
@yozora/tokenizer-delete	Resolve GFM strikethrough (extension)
@yozora/tokenizer-emphasis	Resolve GFM emphasis and strong emphasis
@yozora/tokenizer-fenced-code	Resolve GFM fenced code blocks
@yozora/tokenizer-heading	Resolve GFM ATX headings
@yozora/tokenizer-html-block	Resolve GFM HTML blocks
@yozora/tokenizer-html-inline	Resolve GFM raw HTML
@yozora/tokenizer-image	Resolve GFM images
@yozora/tokenizer-image-reference	Resolve GFM reference images
@yozora/tokenizer-indented-code	Resolve GFM indented code blocks
@yozora/tokenizer-inline-code	Resolve GFM code spans
@yozora/tokenizer-link	Resolve GFM links
@yozora/tokenizer-link-reference	Resolve GFM reference links
@yozora/tokenizer-list	Resolve GFM lists (with GFM list items and GFM task list items)
@yozora/tokenizer-paragraph	Resolve GFM paragraphs
@yozora/tokenizer-setext-heading	Resolve GFM setext headings
@yozora/tokenizer-table	Resolve GFM tables
@yozora/tokenizer-text	Resolve GFM textual contents
@yozora/tokenizer-thematic-break	Resolve GFM thematic breaks

Live Examples

Thematic break

See @yozora/tokenizer-thematic-break for details.

1
2
3
***
---
___

ATX headings

See @yozora/tokenizer-heading for details.

1
2
3
4
5
6
# foo
## foo
### foo
#### foo
##### foo
###### foo

Setext headings

See @yozora/tokenizer-setext-heading for details.

1
2
3
4
5
Foo *bar*
=========

Foo *bar*
---------

Indented code blocks

See @yozora/tokenizer-indented-code for details.

1
2
    a simple
      indented code block

Fenced code blocks

See @yozora/tokenizer-fenced-code for details.

1
2
3
4
```
<
 >
```

HTML blocks

See @yozora/tokenizer-html-block for details.

1
2
3
4
5
6
7
<table><tr><td>
<pre>
**Hello**,

_world_.
</pre>
</td></tr></table>

Link reference definitions

See @yozora/tokenizer-definition for details.

1
2
3
[foo]: /url "title"

[foo]

Paragraphs

See @yozora/tokenizer-paragraph for details.

1
2
3
aaa

bbb

Tables (extension)

See @yozora/tokenizer-table for details.

1
2
3
| foo | bar |
| --- | --- |
| baz | bim |

Block quotes

See @yozora/tokenizer-blockquote for details.

1
2
3
> # Foo
> bar
> baz

List items

See @yozora/tokenizer-list for details.

1
2
3
4
5
6
A paragraph
with two lines.

    indented code

> A block quote.

Task list items (extension)

See @yozora/tokenizer-list for details.

1
2
- [ ] foo
- [x] bar

Lists

See @yozora/tokenizer-list for details.

1
2
3
- foo
- bar
+ baz

Code spans

See @yozora/tokenizer-inline-code for details.

1
`foo`

Emphasis and strong emphasis

See @yozora/tokenizer-emphasis for details.

1
*foo bar*

Strikethrough (extension)

See @yozora/tokenizer-delete for details.

1
~~Hi~~ Hello, world!

Links

See @yozora/tokenizer-link for details.

1
[link](/uri "title")

Reference links

See @yozora/tokenizer-link-reference for details.

1
2
3
[foo][bar]

[bar]: /url "title"

Images

See @yozora/tokenizer-image for details.

1
![foo](/url "title")

Reference images

See @yozora/tokenizer-image-reference for details.

1
2
3
![foo][bar]

[bar]: /url

Autolinks

See @yozora/tokenizer-autolink for details.

1
<http://foo.bar.baz>

Autolinks (extension)

See @yozora/tokenizer-autolink-extension for details.

1
www.commonmark.org

Raw HTML

See @yozora/tokenizer-html-inline for details.

1
<a><bab><c2c>

Hard line breaks

See @yozora/tokenizer-break for details.

1
2
foo  
baz

Soft line breaks

See @yozora/tokenizer-break for details.

1
2
foo
baz

Textual content

See @yozora/tokenizer-text for details.

1
hello $.;'there

Install​

Usage​

Options​

Overview​

Live Examples​

Thematic break​

ATX headings​

Setext headings​

Indented code blocks​

Fenced code blocks​

HTML blocks​

Link reference definitions​

Paragraphs​

Tables (extension)​

Block quotes​

List items​

Task list items (extension)​

Lists​

Code spans​

Emphasis and strong emphasis​

Strikethrough (extension)​

Links​

Reference links​

Images​

Reference images​

Autolinks​

Autolinks (extension)​

Raw HTML​

Hard line breaks​

Soft line breaks​

Textual content​

Related​

Install

Usage

Options

Overview

Live Examples

Thematic break

ATX headings

Setext headings

Indented code blocks

Fenced code blocks

HTML blocks

Link reference definitions

Paragraphs

Tables (extension)

Block quotes

List items

Task list items (extension)

Lists

Code spans

Emphasis and strong emphasis

Strikethrough (extension)

Links

Reference links

Images

Reference images

Autolinks

Autolinks (extension)

Raw HTML

Hard line breaks

Soft line breaks

Textual content

Related