Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xu-cheng/pandoc-katex
Pandoc filter to render math equations using KaTeX
https://github.com/xu-cheng/pandoc-katex
katex latex pandoc rust
Last synced: 3 months ago
JSON representation
Pandoc filter to render math equations using KaTeX
- Host: GitHub
- URL: https://github.com/xu-cheng/pandoc-katex
- Owner: xu-cheng
- License: apache-2.0
- Created: 2020-02-02T16:26:15.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-27T05:12:00.000Z (over 1 year ago)
- Last Synced: 2024-10-12T21:09:10.848Z (3 months ago)
- Topics: katex, latex, pandoc, rust
- Language: Rust
- Homepage:
- Size: 71.3 KB
- Stars: 32
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# pandoc-katex
[](https://github.com/xu-cheng/pandoc-katex/actions)
[](https://crates.io/crates/pandoc-katex)
A [pandoc filter](https://pandoc.org/filters.html) to render math equations using [KaTeX](https://katex.org).
It is powered by the [`katex` Rust crate](https://github.com/xu-cheng/katex-rs).
## Install
```bash
cargo install pandoc-katex
```
When building from the source, the following dependencies are required:
* `gcc` and `patch` for Linux, macOS, and MinGW/MSYS2.
* `msvc` for Windows.
Alternatively, you can download the pre-built binaries from [releases](https://github.com/xu-cheng/pandoc-katex/releases).
## Usage
```bash
pandoc -t html --filter pandoc-katex \
--css "https://cdn.jsdelivr.net/npm/katex@$(pandoc-katex --katex-version)/dist/katex.min.css" \
--css "https://pandoc.org/demo/pandoc.css" \
--standalone -o output.html /path/to/input.md
```
You can also pass additional flags to custom KaTeX rendering. For example, to use custom LaTeX macros:
```bash
pandoc -t json /path/to/input.md | \
pandoc-katex --macro '\RR:\mathbb{R}' | \
pandoc -f json -t html \
--css "https://cdn.jsdelivr.net/npm/katex@$(pandoc-katex --katex-version)/dist/katex.min.css" \
--css "https://pandoc.org/demo/pandoc.css" \
--standalone -o output.html
```
For more flags, see `pandoc-katex --help`.
## Configuration File
Options can also be read from an external configuration file. The configuration file should be in `.toml` format. For example:
```toml
fleqn = true
[macros]
"\\RR" = "\\mathbb{R}"
```
The configuration file path can either be passed as a command line argument `--config-file /path/to/config.toml` or set by environment variable `PANDOC_KATEX_CONFIG_FILE`.
The configuration file accepts the following options. Please refer to for more information.
| Option | Meaning | Accepted values |
|--------|---------|-----------------|
| `output_type` | Set KaTeX output type. | `"html"`, `"mathml"`, `"htmlAndMathml"` |
| `leqno` | Whether to have `\tags` rendered on the left instead of the right. | Boolean |
| `fleqn` | Whether to make display math flush left. | Boolean |
| `throw_on_error` | Whether to let KaTeX throw a `ParseError` for invalid LaTeX. | Boolean |
| `error_color` | Color used for invalid LaTeX. | String |
| `min_rule_thickness` | Minimum thickness, in ems. | Float |
| `max_size` | Max size for user-specified sizes. | Float |
| `max_expand` | Limit for the number of macro expansions. | Int |
| `trust` | Whether to trust users' input. | Boolean |
| `macros` | Custom macros. | Dictionary |
## License
Licensed under either of Apache License, Version 2.0 or MIT license at your option.
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.