JarCasting
JarCasting JarCasting

markdown-it-katex

WebJar for markdown-it-katex

License

License

MIT
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

markdown-it-katex
Last Version

Last Version

2.0.3
Release Date

Release Date
Type

Type

jar
Description

Description

markdown-it-katex
WebJar for markdown-it-katex
Project URL

Project URL

http://webjars.org
Source Code Management

Source Code Management

https://github.com/waylonflinn/markdown-it-katex

Download markdown-it-katex

Filename Size
markdown-it-katex-2.0.3.pom
markdown-it-katex-2.0.3.jar 12 KB
markdown-it-katex-2.0.3-sources.jar 22 bytes
markdown-it-katex-2.0.3-javadoc.jar 22 bytes
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/markdown-it-katex/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>markdown-it-katex</artifactId>
    <version>2.0.3</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/markdown-it-katex/
implementation 'org.webjars.npm:markdown-it-katex:2.0.3'
// https://jarcasting.com/artifacts/org.webjars.npm/markdown-it-katex/
implementation ("org.webjars.npm:markdown-it-katex:2.0.3")
'org.webjars.npm:markdown-it-katex:jar:2.0.3'
<dependency org="org.webjars.npm" name="markdown-it-katex" rev="2.0.3">
  <artifact name="markdown-it-katex" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='markdown-it-katex', version='2.0.3')
)
libraryDependencies += "org.webjars.npm" % "markdown-it-katex" % "2.0.3"
[org.webjars.npm/markdown-it-katex "2.0.3"]

Dependencies

compile (1)

Group / Artifact Type Version
org.webjars.npm : katex jar [0.6.0,0.7)

Project Modules

There are no modules declared in this project.

markdown-it-katex

Add Math to your Markdown

Build Status

KaTeX is a faster alternative to MathJax. This plugin makes it easy to support in your markdown.

Need convincing?

Usage

Install markdown-it

npm install markdown-it

Install the plugin

npm install markdown-it-katex

Use it in your javascript

var md = require('markdown-it')(),
    mk = require('markdown-it-katex');

md.use(mk);

// double backslash is required for javascript strings, but not html input
var result = md.render('# Math Rulez! \n  $\\sqrt{3x-1}+(1+x)^2$');

Include the KaTeX stylesheet in your html:

<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.5.1/katex.min.css">

If you're using the default markdown-it parser, I also recommend the github stylesheet:

<link rel="stylesheet" href="https://cdn.jsdelivr.net/github-markdown-css/2.2.1/github-markdown.css"/>

KaTeX options can be supplied with the second argument to use.

md.use(mk, {"throwOnError" : false, "errorColor" : " #cc0000"});

Examples

Inline

Surround your LaTeX with a single $ on each side for inline rendering.

$\sqrt{3x-1}+(1+x)^2$

Block

Use two ($$) for block rendering. This mode uses bigger symbols and centers the result.

$$\begin{array}{c}

\nabla \times \vec{\mathbf{B}} -\, \frac1c\, \frac{\partial\vec{\mathbf{E}}}{\partial t} &
= \frac{4\pi}{c}\vec{\mathbf{j}}    \nabla \cdot \vec{\mathbf{E}} & = 4 \pi \rho \\

\nabla \times \vec{\mathbf{E}}\, +\, \frac1c\, \frac{\partial\vec{\mathbf{B}}}{\partial t} & = \vec{\mathbf{0}} \\

\nabla \cdot \vec{\mathbf{B}} & = 0

\end{array}$$

Syntax

Math parsing in markdown is designed to agree with the conventions set by pandoc:

Anything between two $ characters will be treated as TeX math. The opening $ must
have a non-space character immediately to its right, while the closing $ must
have a non-space character immediately to its left, and must not be followed
immediately by a digit. Thus, $20,000 and $30,000 won’t parse as math. If for some
reason you need to enclose text in literal $ characters, backslash-escape them and
they won’t be treated as math delimiters.

Math Syntax Support

KaTeX is based on TeX and LaTeX. Support for both is growing. Here's a list of currently supported functions:

Function Support in KaTeX

Versions

Version
2.0.3