mdbook-katex-0.1.4 is not a library.
Visit the last successful build:
mdbook-katex-0.8.0
A Preprocessor for mdbook, converting Latex equations to html at compile time. This preprocessor uses the katex crate; see this page for supported Latex functions.
Basic Usage
First, install the crate
cargo install mdbook-katex
Then, add the KaTex preprocessor to your book.toml
file
[]
= "mdbook-katex"
Once this is done, you can use KaTex expressions within your .md
files, using $
and $$
delimiters. Use \$
for a regular dollar symbol.
# Chapter 1
Here is an inline example, $ \pi(\theta) $,
An equation:
$$ \nabla f(x) \in \mathbb{R}^n $$
And a regular \$ symbol.
Macros
Macros with no arguments are supported. They must be specified in a .txt
file, according to the following pattern
\grad:{\nabla}
\Rn:{\mathbb{R}^n}
Then, change the preprocessor command in your book.toml
to tell it where the macros are located
[]
= "mdbook-katex --macros=path/to/macros.txt"
You can now use these macros in any .md
file.
# Chapter 1
$$ \grad f(x) \in \Rn $$