katex-rs - GitLite

KO | EN

gitlite — search

#react #go #machine-learning #rust #deep-learning #linux #docker #nodejs #macos #java #cli #kubernetes #mcp #openai

katex-rs

(★ 127)

Rust bindings to KaTeX

File Explorer

Download Latest Version (.zip)

- - build.yml
  - clippy.yml
  - fmt.yml
- FUNDING.yml
- entry.js
- node-hack.js
- post-node-hack.js
- - duktape.rs
  - quick_js.rs
  - wasm_js.rs
- error.rs
- js_engine.rs
- lib.rs
- opts.rs
- tests.rs
- - mhchem.min.js
- KATEX-LICENSE
- katex.min.js
.editorconfig
.gitignore
build.rs
Cargo.toml
download_katex.sh
KATEX-VERSION
LICENSE-APACHE
LICENSE-MIT
README.md

# Installation Guide

1. Get the code

git clone https://github.com/xu-cheng/katex-rs

Downloads the entire project code from GitHub to your computer.

cd katex-rs

Moves into the project folder you just downloaded.

2. Rust

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Rust (rustup) Installing via rustup also installs cargo.

cargo build --release

Compiles the Rust project.

cargo run

Builds and then immediately runs the program.

✅ If cargo build finishes without errors, it worked. The executable is created under target/.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# katex-rs

[![Build Status](https://github.com/xu-cheng/katex-rs/workflows/build/badge.svg)](https://github.com/xu-cheng/katex-rs/actions)
[![Latest Version](https://img.shields.io/crates/v/katex.svg)](https://crates.io/crates/katex)
[![Rust Documentation](https://docs.rs/katex/badge.svg)](https://docs.rs/katex)

This crate offers Rust bindings to [KaTeX](https://katex.org). This allows you to render LaTeX equations to HTML.

## Documentation

<https://docs.rs/katex>

## Usage

Add this to your `Cargo.toml`:

```toml
[dependencies]
katex = "0.4"
```

This crate offers the following features:

* `quick-js`: Enable by default. Use [quick-js](https://crates.io/crates/quick-js) as the JS backend.
* `duktape`: Use [duktape](https://crates.io/crates/ducc) as the JS backend. You need to disable the default features to enable this backend.
* `wasm-js`: Use [wasm-bindgen](https://crates.io/crates/wasm-bindgen) and [js-sys](https://crates.io/crates/js-sys) as the JS backend. You need to disable the default features to enable this backend.

## Examples

```rust
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();
```

## See Also

* [pandoc-katex](https://github.com/xu-cheng/pandoc-katex)

## License

<sup>
Licensed under either of <a href="LICENSE-APACHE">Apache License, Version 2.0</a> or <a href="LICENSE-MIT">MIT license</a> at your option.
</sup>
<br>
<sub>
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
</sub>