@yozora/tokenizer-inline-math produces InlineMath nodes. See documentation for details.

Install

npm install --save @yozora/tokenizer-inline-math

Usage

@yozora/tokenizer-inline-math 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 InlineMathTokenizer from '@yozora/tokenizer-inline-math'

const parser = new DefaultParser()
  .useFallbackTokenizer(new ParagraphTokenizer())
  .useFallbackTokenizer(new TextTokenizer())
  .useTokenizer(new InlineMathTokenizer({ backtickRequired: true }))
  .useTokenizer(new InlineMathTokenizer({ backtickRequired: false }))

parser.parse("`$x^2 + y^2 = z^2, x < 0$`")

With @yozora/parser

import YozoraParser from '@yozora/parser'

const parser = new YozoraParser()

parser.parse("`$x^2 + y^2 = z^2, x < 0$`")

With @yozora/parser-gfm

import GfmParser from '@yozora/parser-gfm'
import InlineMathTokenizer from '@yozora/tokenizer-inline-math'

const parser = new GfmParser()
parser.useTokenizer(new InlineMathTokenizer({ backtickRequired: true }))

parser.parse("`$x^2 + y^2 = z^2, x < 0$`")

With @yozora/parser-gfm-ex

import GfmExParser from '@yozora/parser-gfm-ex'
import InlineMathTokenizer from '@yozora/tokenizer-inline-math'

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

parser.parse("`$x^2 + y^2 = z^2, x < 0$`")

Options

| Name | Type | Required | Default | | :----------------- | :-------- | :------- | :-------------------------------------------------------- | | name | string | No | Depends on backtickRequired | | priority | number | No | ATOMIC with backticks; otherwise INTERRUPTABLE_INLINE | | backtickRequired | boolean | No | true |

• name: Defaults to @yozora/tokenizer-inline-math_with_backtick when backtickRequired is true, otherwise @yozora/tokenizer-inline-math.

• priority: Processing priority. Tokenizers with higher values run first.

• backtickRequired: Require the math expression to be wrapped in both backticks and dollar signs.

Related

• @yozora/ast
• @yozora/parser
• @yozora/parser-gfm
• @yozora/parser-gfm-ex
• @yozora/tokenizer-math
• @yozora/react-math
• @yozora/react-markdown
• Live Examples
• InlineMath | Yozora AST
• Documentation