@yozora/tokenizer-footnote-definition produces FootnoteDefinition nodes. See documentation for details.

Install

npm install --save @yozora/tokenizer-footnote-definition

Usage

@yozora/tokenizer-footnote-definition 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 FootnoteDefinitionTokenizer from '@yozora/tokenizer-footnote-definition'

const parser = new DefaultParser()
  .useFallbackTokenizer(new ParagraphTokenizer())
  .useFallbackTokenizer(new TextTokenizer())
  .useTokenizer(new FootnoteDefinitionTokenizer())

parser.parse(`
Here is a footnote reference,[^1]
another,[^long note],

[^big footnote]: Here's one with multiple paragraphs and code.

    Indent paragraphs to include them in the footnote.

    \`\`\`
    Fenced code
    \`\`\`

    ## heading

    Add as many paragraphs as you like.
`)

With @yozora/parser

import YozoraParser from '@yozora/parser'

const parser = new YozoraParser()

parser.parse(`
Here is a footnote reference,[^1]
another,[^long note],

[^big footnote]: Here's one with multiple paragraphs and code.

    Indent paragraphs to include them in the footnote.

    \`\`\`
    Fenced code
    \`\`\`

    ## heading

    Add as many paragraphs as you like.
`)

With @yozora/parser-gfm

FootnoteDefinitionTokenizer should take precedence over DefinitionTokenizer.

import GfmParser from '@yozora/parser-gfm'
import { DefinitionTokenizerName } from '@yozora/tokenizer-definition'
import FootnoteDefinitionTokenizer from '@yozora/tokenizer-footnote-definition'

const parser = new GfmParser()
parser.useTokenizer(new FootnoteDefinitionTokenizer(), DefinitionTokenizerName)

parser.parse(`
Here is a footnote reference,[^1]
another,[^long note],

[^big footnote]: Here's one with multiple paragraphs and code.

    Indent paragraphs to include them in the footnote.

    \`\`\`
    Fenced code
    \`\`\`

    ## heading

    Add as many paragraphs as you like.
`)

With @yozora/parser-gfm-ex

import GfmExParser from '@yozora/parser-gfm-ex'
import { DefinitionTokenizerName } from '@yozora/tokenizer-definition'
import FootnoteDefinitionTokenizer from '@yozora/tokenizer-footnote-definition'

const parser = new GfmExParser()
parser.useTokenizer(new FootnoteDefinitionTokenizer(), DefinitionTokenizerName)

parser.parse(`
Here is a footnote reference,[^1]
another,[^long note],

[^big footnote]: Here's one with multiple paragraphs and code.

    Indent paragraphs to include them in the footnote.

    \`\`\`
    Fenced code
    \`\`\`

    ## heading

    Add as many paragraphs as you like.
`)

Options

| Name | Type | Required | Default | | :--------- | :------- | :------- | :---------------------------------------- | | name | string | No | "@yozora/tokenizer-footnote-definition" | | priority | number | No | TokenizerPriority.CONTAINING_BLOCK |

• 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.

Related

• @yozora/ast
• @yozora/parser
• @yozora/parser-gfm
• @yozora/parser-gfm-ex
• @yozora/tokenizer-footnote
• @yozora/tokenizer-definition
• @yozora/react-footnote-definitions
• @yozora/react-footnote-reference
• @yozora/react-markdown
• Live Examples
• FootnoteDefinition | Yozora AST
• Documentation