Skip to content
🔣 KaTeX support for docsify
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE
dist
docs
images
src
.eslintrc.json
.gitignore
.nojekyll
CHANGELOG.md
LICENSE
README.md Updated: gh js file link Mar 16, 2019
package.json
webpack.config.js

README.md

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:

<!-- 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> -->
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/katex@latest/dist/katex.min.css"/>

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.
  2. You don't need katex.min.js, because it is already included in docsify-katex.js.

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. The main difficulty is that we cannot know context of the whole markdown file like yzhang-gh/markdown-it-katex does, so matching complicate `'s and $'s is not possible. Now we have such known issues:

  1. Change \` to:

    <code>`</code>
    

    By doing this, your ` will not be considered as a start or end of a code block.

You can’t perform that action at this time.