@widcardw/remark-asciimath

remark asciimath

Transform AsciiMath codeblock and inline code (wrapped with `$ and $`) to math-display and math-inline.

How to use

This plugin is ESM only. You can install it with package manager.

pnpm i remark-asciimath

Then use this plugin.

unified()
  .use(remarkParse)
  .use(remarkAsciiMath as any, { display: false })
  .use(remarkRehype)
  .use(rehypeStringify)
  .processSync('.....')

This plugin works like remark-math. If your markdown looks like

```am
lim_(n->oo)(1+1/n)^n="e"
```

It yields

<div class="math math-display">\lim _{ n \to \infty } \left( 1 + \frac{ 1 }{ n } \right) ^{ n } = \text{e}</div>

It also supports inline formula.

`$int_0^(+oo)"e"^-x dx$`

The result

<p><span class="math math-inline">\int _{ 0 } ^{ + \infty } \text{e} ^{ {-x} } {\text{d}x}</span></p>

As a result, if you want to display math in DOM, please use rehype-katex also.

Configuration

interface AmConfig {
  /**
   * codeblock languages
   * @default ['am', 'asciimath']
   */
  prefixes?: string | string[]
  /**
   * Leading escape of inline formula
   * @default `$
   */
  inlineOpen?: string
  /**
   * Trailing escape of inline formula
   * @default $`
   */
  inlineClose?: string
  /**
   * Whether to enable displayMode
   * @default true
   */
  display?: boolean
  /**
   * Extend const tokens
   */
  extConst?: [string, string][]
  /**
   * Replace expressions before process
   */
  replaceBeforeTokenizing?: [RegExp | string, string | ((substring: string, ...args: any[]) => string)][]
}