Code Monkey home page Code Monkey logo

docsify-katex's Introduction

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.

docsify-katex's People

Contributors

upupming avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.