mirror of
https://github.com/vale981/riot-katex
synced 2025-03-04 16:51:37 -05:00
28 lines
851 B
Markdown
28 lines
851 B
Markdown
#  Riot KaTeX
|
|
|
|
This extension injects KaTeX into the `Riot` chat client for
|
|
`matrix`.
|
|
|
|
## Writing LaTeX
|
|
- `$$x^2$$` renders math block style
|
|
- `\(x^2\)` renders math inline
|
|
|
|
|
|
## Download and Installation
|
|
You can download the extension [from
|
|
here](https://github.com/vale981/riot-katex/releases/latest). Just
|
|
double click it, or drag it one firefox to install.
|
|
|
|
## Example
|
|
|
|
|
|
## Building the Extension
|
|
- make sure you have npm installed
|
|
- run `npm install`, the webextension will be zipped as
|
|
`build/katex-riot.zip` and the file structure of the extionsion is
|
|
written to the folder `build/katex-riot-pub` for debugging
|
|
- to clean all build artifacts, just run `npm run clean`
|
|
|
|
## Thanks
|
|
Thanks to [KaTeX](https://katex.org/) for providing the blazingly fast
|
|
rendering library for LaTeX formulas.
|