Skip to content

Commit ef6db15

Browse files
committed
docs: update README
1 parent f316b13 commit ef6db15

File tree

3 files changed

+5
-3
lines changed

3 files changed

+5
-3
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
## Features
1515

1616
- Compliant with [CommonMark 0.31.2](https://spec.commonmark.org/0.31.2/ "commonmark spec")
17+
- Math rendering support (using a forked version of [comrak](https://github.com/DoublePrecision/comrak "comrak fork"))
1718
- Syntax highlighting using [syntect](https://github.com/trishume/syntect "syntect github")
1819
- Huge support for languages and themes
1920
- Easy to use
@@ -101,8 +102,8 @@ For a list of available themes and languages, please refer to [THEMES_AND_LANGS.
101102

102103
## Internals
103104

104-
Internally, the renderer is implemented using the [comrak](https://github.com/kivikakk/comrak "comrak github") library and then compiled down to webassembly using [wasm-pack](https://github.com/rustwasm/wasm-pack "wasm-pack github")
105-
which is [called](./vite.config.ts) by [vite](https://vite.dev/ "vite website").
105+
Internally, the renderer is implemented using a [forked version of comrak](https://github.com/DoublePrecision/comrak "comrak fork") (with added math rendering support) and then compiled down to webassembly using [wasm-pack](https://github.com/rustwasm/wasm-pack "wasm-pack github")
106+
which is [called](./vite.config.ts) by [vite](https://vite.dev/ "vite website"). The fork extends the original [comrak](https://github.com/kivikakk/comrak "comrak github") library to include mathematical expression rendering capabilities.
106107

107108
## Security
108109

markdown-renderer/Cargo.lock

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

markdown-renderer/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ crate-type = ["cdylib"]
88

99
[dependencies]
1010
wasm-bindgen = "0.2.105"
11-
comrak = { path = "../../comrak", default-features = false }
11+
comrak = { git = "https://github.com/DoublePrecision/comrak.git", branch = "feat/math-renderer", default-features = false }
1212
once_cell = "1.21.3"
1313
syntect = { version = "5.0.0", default-features = false, features = ["default-fancy"]}
1414

0 commit comments

Comments
 (0)