Crate katex

Source
Expand description

This crate offers Rust bindings to KaTeX. This allows you to render LaTeX equations to HTML.

§Usage

Add this to your Cargo.toml:

[dependencies]
katex = "0.4"

This crate offers the following features:

  • quick-js: Enable by default. Use quick-js as the JS backend.
  • duktape: Use duktape as the JS backend. You need to disable the default features to enable this backend.
  • wasm-js: Use wasm-bindgen and js-sys as the JS backend. You need to disable the default features to enable this backend.

§Examples

let html = katex::render("E = mc^2").unwrap();

let opts = katex::Opts::builder().display_mode(true).build().unwrap();
let html_in_display_mode = katex::render_with_opts("E = mc^2", &opts).unwrap();

Re-exports§

pub use error::Error;
pub use error::Result;
pub use opts::Opts;
pub use opts::OptsBuilder;
pub use opts::OutputType;

Modules§

error
Error handling for this crate.
opts
Custom KaTeX behaviors.

Constants§

KATEX_VERSION
KaTeX version.

Functions§

render
Render LaTeX equation to HTML.
render_with_opts
Render LaTeX equation to HTML with additional options.