@yozora/tokenizer-footnote-reference

note

Install

npm

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

Yarn

yarn add @yozora/tokenizer-footnote-reference

pnpm

pnpm add @yozora/tokenizer-footnote-reference

Usage

tip

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

Basic Usage

@yozora/tokenizer-footnote-reference 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 FootnoteReferenceTokenizer from '@yozora/tokenizer-footnote-reference'

const parser = new DefaultYastParser()
  .useBlockFallbackTokenizer(new ParagraphTokenizer())
  .useInlineFallbackTokenizer(new TextTokenizer())
  .useTokenizer(new FootnoteReferenceTokenizer())

// parse source markdown content
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 coding
      \`\`\`
  
      ## heading
  
      Add as many paragraphs as you like.
  `)

YozoraParser

import YozoraParser from '@yozora/parser'

const parser = new YozoraParser()

// parse source markdown content
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 coding
      \`\`\`
  
      ## heading
  
      Add as many paragraphs as you like.
  `)

GfmParser

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

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

// parse source markdown content
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 coding
      \`\`\`
  
      ## heading
  
      Add as many paragraphs as you like.
  `)

GfmExParser

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

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

// parse source markdown content
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 coding
      \`\`\`
  
      ## heading
  
      Add as many paragraphs as you like.
  `)

Options

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

• 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-reference produce FootnoteReference type nodes. See @yozora/ast for full base types.

import type { YastAssociation, YastNode } from '@yozora/ast'

export const FootnoteReferenceType = 'footnoteReference'
export type FootnoteReferenceType = typeof FootnoteReferenceType

/**
 * FootnoteReference represents a marker through association.
 *
 * Similar to imageReference and linkReference, the difference is that it has
 * only 'collapsed' reference type instead of 'full' and 'shortcut'
 * @see https://github.com/syntax-tree/mdast#footnotereference
 * @see https://github.com/syntax-tree/mdast#imagereference
 * @see https://github.com/syntax-tree/mdast#linkreference
 */
export interface FootnoteReference
  extends YastNode<FootnoteReferenceType>, YastAssociation {}

Live Examples

Related

• @yozora/ast
• @yozora/parser
• @yozora/tokenizer-definition
• @yozora/tokenizer-footnote
• @yozora/react-footnote-definitions
• @yozora/react-footnote-reference
• @yozora/react-markdown
• Sourcecode
• FootnoteReference | Yozora AST