https://github.com/vuepress/vuepress-plugin-mathjax

:page_with_curl: Use TeX in VuePress.
https://github.com/vuepress/vuepress-plugin-mathjax

Last synced: 3 months ago
JSON representation

:page_with_curl: Use TeX in VuePress.

• Host: GitHub
• URL: https://github.com/vuepress/vuepress-plugin-mathjax
• Owner: vuepress
• License: mit
• Archived: true
• Created: 2019-02-23T17:30:15.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-10T17:05:46.000Z (almost 2 years ago)
• Last Synced: 2024-07-10T17:09:05.725Z (4 months ago)
• Language: JavaScript
• Homepage: https://vuepress.github.io/plugins/mathjax.html
• Size: 2.26 MB
• Stars: 32
• Watchers: 2
• Forks: 10
• Open Issues: 41
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [vuepress-plugin-mathjax](https://vuepress.github.io/plugins/mathjax/)

[![npm](https://img.shields.io/npm/v/vuepress-plugin-mathjax.svg)](https://www.npmjs.com/package/vuepress-plugin-mathjax)

[![CircleCI](https://img.shields.io/circleci/project/github/vuepress/vuepress-plugin-mathjax/master.svg)](https://circleci.com/gh/vuepress/vuepress-plugin-mathjax)

A [VuePress](https://vuepress.vuejs.org/) plugin which supports TeX syntax in markdown files.

## Usage

```bash

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](https://github.com/isaacs/node-lru-cache) Options. If set to `false`, no cache will be used.

## Contribution

Contribution Welcome!