@yozora/tokenizer-admonition

note

Install

npm

npm install --save @yozora/tokenizer-admonition

Yarn

yarn add @yozora/tokenizer-admonition

pnpm

pnpm add @yozora/tokenizer-admonition

Usage

tip

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

Basic Usage

@yozora/tokenizer-admonition 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 AdmonitionTokenizer from '@yozora/tokenizer-admonition'

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

// parse source markdown content
parser.parse(`
:::info[this is a info type admonition]
waw

### some block contents
:::
`)

YozoraParser

import YozoraParser from '@yozora/parser'

const parser = new YozoraParser()

// parse source markdown content
parser.parse(`
:::info[this is a info type admonition]
waw

### some block contents
:::
`)

GfmParser

import GfmParser from '@yozora/parser-gfm'
import AdmonitionTokenizer from '@yozora/tokenizer-admonition'

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

// parse source markdown content
parser.parse(`
:::info[this is a info type admonition]
waw

### some block contents
:::
`)

GfmExParser

import GfmExParser from '@yozora/parser-gfm-ex'
import AdmonitionTokenizer from '@yozora/tokenizer-admonition'

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

// parse source markdown content
parser.parse(`
:::info[this is a info type admonition]
waw

### some block contents
:::
`)

Options

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

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

Types

@yozora/tokenizer-admonition produce Admonition type nodes. See @yozora/ast for full base types.

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

export const AdmonitionType = 'admonition'
export type AdmonitionType = typeof AdmonitionType

/**
 * Admonitions are block elements. The titles can include inline markdown and
 * the body can include any block markdown except another admonition.
 * @see https://github.com/elviswolcott/remark-admonitions
 */
export interface Admonition extends YastParent<AdmonitionType> {
  /**
   * Keyword of an admonition.
   */
  keyword: 'note' | 'important' | 'tip' | 'caution' | 'warning' | string
  /**
   * Admonition title.
   */
  title: YastNode[]
}

Live Examples

• Basic Usage.

  #1

  yozora

    

  pretty-json

    

  :::note optional title some content :::

  1
  2
  3
  :::note optional title
  some content
  :::

• Admonition body could be empty.

  #2

  yozora

    

  pretty-json

    

  :::important :::

  1
  2
  :::important
  :::

• Admonition body supported full features of markdown.

  #3

  yozora

    

  pretty-json

    

  :::important some content - list item - list item 2 > blockquote ## heading :::

  1
  2
  3
  4
  5
  6
  7
  :::important
  some content
  - list item
  - list item 2
  > blockquote
  ## heading
  :::

• Admonition title could include inlines.

  #4

  yozora

    

  pretty-json

    

  :::tip title could `include` **inline contents** some content :::

  1
  2
  3
  :::tip title could `include` **inline contents**
  some content
  :::

Related

• @yozora/ast
• @yozora/parser
• @yozora/parser-gfm
• @yozora/parser-gfm-ex
• @yozora/react-admonition
• @yozora/react-markdown
• Sourcecode
• Admonition | Yozora AST