https://github.com/upupming/docsify-katex

:symbols: KaTeX support for docsify
https://github.com/upupming/docsify-katex

demo docsify docsify-katex katex katex-support mathjax

Last synced: 3 months ago
JSON representation

:symbols: KaTeX support for docsify

• Host: GitHub
• URL: https://github.com/upupming/docsify-katex
• Owner: upupming
• License: mit
• Created: 2018-10-17T10:16:37.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T19:36:25.000Z (almost 2 years ago)
• Last Synced: 2024-07-21T18:16:35.962Z (4 months ago)
• Topics: demo, docsify, docsify-katex, katex, katex-support, mathjax
• Language: JavaScript
• Homepage: https://upupming.site/docsify-katex/docs
• Size: 596 KB
• Stars: 84
• Watchers: 3
• Forks: 32
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# docsify-katex

[![jsdelivr](https://data.jsdelivr.com/v1/package/npm/docsify-katex/badge)](https://www.jsdelivr.com/package/npm/docsify-katex)

[![npm bundle size (minified)](https://img.shields.io/github/size/upupming/docsify-katex/dist/docsify-katex.js.svg?style=flat-square)](https://www.npmjs.com/package/docsify-katex)

[![npm](https://img.shields.io/npm/v/docsify-katex.svg?style=flat-square)](https://www.npmjs.com/package/docsify-katex)

Add [KaTeX](https://github.com/KaTeX/KaTeX/) support to your docsify project.

## Usage

Add `docsify-katex` JS and CSS scripts to your `index.html`:

```html

```

Note:

1. `gh/upupming/docsify-katex@latest/dist/docsify-katex.js` will always fetch the latest version of `docsify-katex` on GitHub, you can use it when you want to try the latest dev features.

## Demo projects

|             Name              |                                    Website                                    |                                        Source code                                        |

| :---------------------------: | :---------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------: |

| `docsify-katex` documentation | [upupming.site/docsify-katex/docs](https://upupming.site/docsify-katex/docs/) | [upupming/docsify-katex/docs](https://github.com/upupming/docsify-katex/tree/master/docs) |

|           Firebook            |       [yngtodd.github.io/firebook](https://yngtodd.github.io/firebook/)       |                  [yngtodd/firebook](https://github.com/yngtodd/firebook)                  |

If you have an awesome project using `docsify-katex` and want to share it with others, please leave it at [this issue](https://github.com/upupming/docsify-katex/issues/7). I will add it here as soon as possible.

## LaTeX quick reference

- [Supported functions](https://upupming.site/docsify-katex/docs/#/supported)

- [Support table](https://upupming.site/docsify-katex/docs/#/support-table)

- [Detexify](http://detexify.kirelabs.org/classify.html)

- [MathJax quick reference on Stack Exchange](https://math.meta.stackexchange.com/questions/5020/mathjax-basic-tutorial-and-quick-reference)

## Inspired by

1. [vscode-markdown](https://github.com/yzhang-gh/vscode-markdown)

2. [yzhang-gh/markdown-it-katex](https://github.com/yzhang-gh/markdown-it-katex)

## Credits

1. [KaTeX](https://github.com/Khan/KaTeX)

## Known issues

Making KaTeX work properly with docsify is a hard work, this repo is just a workaround. We used an extra `marked` instance to do the syntax parsing.