@yozora/tokenizer-footnote
v2.4.0
Published
Downloads
25,199
Readme
@yozora/tokenizer-footnote produces Footnote nodes. See documentation for details.
Install
npm install --save @yozora/tokenizer-footnoteUsage
@yozora/tokenizer-footnote is built into @yozora/parser.
With DefaultParser
A tokenizer must be registered with an IParser before use.
import { DefaultParser } from '@yozora/core-parser'
import ParagraphTokenizer from '@yozora/tokenizer-paragraph'
import TextTokenizer from '@yozora/tokenizer-text'
import FootnoteTokenizer from '@yozora/tokenizer-footnote'
const parser = new DefaultParser()
.useFallbackTokenizer(new ParagraphTokenizer())
.useFallbackTokenizer(new TextTokenizer())
.useTokenizer(new FootnoteTokenizer())
parser.parse(`
^[inline footnote]
^[footnote with *emphasis* and $x^2+y^2$ and `inline code`]
`)With @yozora/parser
import YozoraParser from '@yozora/parser'
const parser = new YozoraParser()
parser.parse(`
^[inline footnote]
^[footnote with *emphasis* and $x^2+y^2$ and `inline code`]
`)With @yozora/parser-gfm
import GfmParser from '@yozora/parser-gfm'
import FootnoteTokenizer from '@yozora/tokenizer-footnote'
const parser = new GfmParser()
parser.useTokenizer(new FootnoteTokenizer())
parser.parse(`
^[inline footnote]
^[footnote with *emphasis* and $x^2+y^2$ and `inline code`]
`)With @yozora/parser-gfm-ex
import GfmExParser from '@yozora/parser-gfm-ex'
import FootnoteTokenizer from '@yozora/tokenizer-footnote'
const parser = new GfmExParser()
parser.useTokenizer(new FootnoteTokenizer())
parser.parse(`
^[inline footnote]
^[footnote with *emphasis* and $x^2+y^2$ and `inline code`]
`)Options
| Name | Type | Required | Default |
| :--------- | :------- | :------- | :----------------------------- |
| name | string | No | "@yozora/tokenizer-footnote" |
| priority | number | No | TokenizerPriority.LINKS |
name: Unique tokenizer name. Generated tokens retain it so the parser can dispatch later phases to the same tokenizer.priority: Processing priority. Tokenizers with higher values run first. During block matching, a higher-priority tokenizer can interrupt a lower-priority tokenizer.