/vuepress-plugin-mathjax

:page_with_curl: Use TeX in VuePress.

Primary LanguageJavaScriptMIT LicenseMIT

vuepress-plugin-mathjax

npm CircleCI

A VuePress plugin which supports TeX syntax in markdown files.

Usage

npm i vuepress-plugin-mathjax
# OR
yarn add vuepress-plugin-mathjax

Configurations

target

  • type: 'svg' | 'chtml'
  • default: 'chtml'

The output of MathJax.

packages

  • type: string | string[]
  • default: all the MathJax packages available

The MathJax packages to use.

macros

  • type: { [key: string]: string | null }
  • default: {}

Macros will be automatically mixed with built-in macros. To disable a built-in macro, simply set the value to null accordingly. Here is a list of all built-in macros:

presets

  • type: string | string[]
  • default: []

The preset content to be added. The preset content will automatically be inserted before the TeX code.

showError

  • type: boolean
  • default: process.env.NODE_ENV === 'development'

Whether to output an error message in the console when a compilation error is encountered.

cache

  • type: false | object
  • default: {}

LRU Cache Options. If set to false, no cache will be used.

Contribution

Contribution Welcome!