@yozora/tokenizer-footnote

github flavor markdown spec

Install

npm

npm install --save @yozora/tokenizer-footnote

Yarn

yarn add @yozora/tokenizer-footnote

pnpm

pnpm add @yozora/tokenizer-footnote

Usage

tip

@yozora/tokenizer-footnote has been integrated into @yozora/parser, so you can use YozoraParser directly.

Basic Usage

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

import { DefaultYastParser } 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 DefaultYastParser()
  .useBlockFallbackTokenizer(new ParagraphTokenizer())
  .useInlineFallbackTokenizer(new TextTokenizer())
  .useTokenizer(new FootnoteTokenizer())

// parse source markdown content
parser.parse(`
^[inline footnote]

^[footnote with *emphasis* and $x^2+y^2$ and `inline code`]
`)

YozoraParser

import YozoraParser from '@yozora/parser'

const parser = new YozoraParser()

// parse source markdown content
parser.parse(`
^[inline footnote]

^[footnote with *emphasis* and $x^2+y^2$ and `inline code`]
`)

GfmParser

import GfmParser from '@yozora/parser-gfm'
import FootnoteTokenizer from '@yozora/tokenizer-footnote'

const parser = new GfmParser()
parser.useTokenizer(new FootnoteTokenizer())

// parse source markdown content
parser.parse(`
^[inline footnote]

^[footnote with *emphasis* and $x^2+y^2$ and `inline code`]
`)

GfmExParser

import GfmExParser from '@yozora/parser-gfm-ex'
import FootnoteTokenizer from '@yozora/tokenizer-footnote'

const parser = new GfmExParser()
parser.useTokenizer(new FootnoteTokenizer())

// parse source markdown content
parser.parse(`
^[inline footnote]

^[footnote with *emphasis* and $x^2+y^2$ and `inline code`]
`)

Options

Name	Type	Required	Default
name	string	false	"@yozora/tokenizer-footnote"
priority	number	false	TokenizerPriority.LINKS

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

  Exception: Delimiters of type full are always processed before other type delimiters.

Types

@yozora/tokenizer-footnote produce Footnote type nodes. See @yozora/ast for full base types.

import type { YastParent } from '@yozora/ast'

export const FootnoteType = 'footnote'
export type FootnoteType = typeof FootnoteType

/**
 * Footnote represents content relating to the document that is outside its flow.
 * @see https://github.com/syntax-tree/mdast#footnote
 */
export type Footnote = YastParent<FootnoteType>

Live Examples

Related

• @yozora/ast
• @yozora/parser
• @yozora/parser-gfm
• @yozora/parser-gfm-ex
• @yozora/react-footnote-definitions
• @yozora/react-footnote-reference
• @yozora/react-markdown
• Sourcecode
• Footnote | Yozora AST