docsify-katex

2.0.2 • Public • Published

docsify-katex

jsdelivr npm bundle size (minified) npm

Add KaTeX support to your docsify project with just two lines of code in index.html.

Usage

Add docsify-katex CDN to your index.html:

<script src="https://cdn.jsdelivr.net/npm/katex@latest/dist/katex.min.js"></script>
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/katex@latest/dist/katex.min.css" />
<script src="https://cdn.jsdelivr.net/npm/marked@3"></script>

<!-- CDN files for docsify-katex -->
<script src="//cdn.jsdelivr.net/npm/docsify-katex@latest/dist/docsify-katex.js"></script>
<!-- or <script src="//cdn.jsdelivr.net/gh/upupming/docsify-katex@latest/dist/docsify-katex.js"></script> -->

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 upupming/docsify-katex/docs
Firebook yngtodd.github.io/firebook yngtodd/firebook

If you have an awesome project using docsify-katex and want to share it with others, please leave it at this issue. I will add it here as soon as possible.

LaTeX quick reference

Inspired by

  1. vscode-markdown
  2. yzhang-gh/markdown-it-katex

Credits

  1. 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 (version 3.x) to do the syntax parsing.

Package Sidebar

Install

npm i docsify-katex

Weekly Downloads

3,924

Version

2.0.2

License

MIT

Unpacked Size

174 kB

Total Files

24

Last publish

Collaborators

  • upupming