# @renovamen/vuepress-plugin-katex

> A plugin for adding Katex to VuePress.

Latest version **0.2.0** (published 2021-08-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install @renovamen/vuepress-plugin-katex
pnpm add @renovamen/vuepress-plugin-katex
yarn add @renovamen/vuepress-plugin-katex
bun add @renovamen/vuepress-plugin-katex
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2021-08-18 |
| First published | 2020-11-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 8.8 KB |
| Known vulnerabilities | 0 (+4 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 371 |
| Author | Renovamen |
| Maintainers | renovamen |
| Keywords | vue, vuepress, vuepress-plugin, LaTex, KaTeX, markdown |

## Links

- npm: https://www.npmjs.com/package/@renovamen/vuepress-plugin-katex
- Repository: https://github.com/Renovamen/vuepress-theme-gungnir
- Homepage: https://github.com/Renovamen/vuepress-theme-gungnir/tree/main/packages/plugins/katex
- Issues: https://github.com/Renovamen/vuepress-theme-gungnir/issues
- npm.io page: https://npm.io/package/@renovamen/vuepress-plugin-katex

## Dependencies (1)

- [katex](https://npm.io/package/katex.md) ^0.13.10

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 0.2.0 (latest) — 2021-08-18
- 2.0.0-alpha.26 (next) — 2022-08-19
- 2.0.0-alpha.25 — 2022-06-20
- 2.0.0-alpha.24 — 2022-05-29
- 2.0.0-alpha.23 — 2022-05-20
- 2.0.0-alpha.15 — 2022-02-26
- 2.0.0-alpha.10 — 2022-01-24
- 2.0.0-alpha.2 — 2021-12-12
- 0.1.9 — 2021-08-18
- 0.1.8 — 2021-06-16
- 0.1.7 — 2021-04-05
- 0.1.6 — 2021-03-31
- 0.1.5 — 2021-02-28
- 0.1.1 — 2021-02-01
- 0.1.0 — 2020-11-22

## README

# @renovamen/vuepress-plugin-katex

A plugin for for adding [KaTeX](https://katex.org/) to VuePress to support mathematical formulas rendering in Markdown. This plugin is based on [waylonflinn/markdown-it-katex](https://github.com/waylonflinn/markdown-it-katex).

[KaTeX](https://katex.org/) is a faster alternative to MathJax (see [here](https://www.intmath.com/cg5/katex-mathjax-comparison.php)).

[Here](https://katex.org/docs/supported.html) is a list of TeX functions supported by KaTeX.

[Demo](https://vuepress-theme-gungnir.vercel.app/zh/docs/plugins/katex.html)


 

## Usage

Install:

```bash
yarn add @renovamen/vuepress-plugin-katex
# or
npm install @renovamen/vuepress-plugin-katex
```

Enable this plugin in VuePress with [KaTeX options](https://katex.org/docs/options.html):

```js
module.exports = {
  plugins: [
    [
      '@renovamen/vuepress-plugin-katex', {
        'throwOnError': false,  // (optional)
        'errorColor': '#cc0000'  // (optional)
      }
    ]
  ]
}
```

 

## License

[MIT](LICENSE)

---
_Source: https://npm.io/package/@renovamen/vuepress-plugin-katex · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._