riot-katex/README.md
2020-04-09 18:31:03 +02:00

24 lines
764 B
Markdown

# Riot KaTeX
This extension injects KaTeX into the `Riot` chat client for
`matrix`. This currently works for just one domain
(matrix.tu-dresden.de). If you want to use it, you have to adjust the
`manifest.json`.
## Writing LaTeX
- `$$x^2$$` renders math block style
- `\(x^2\)` renders math inline
## Example
[Example](example.png)
## 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.
## Building the Extension
- make sure you have npm installed
- run `./package.sh`, the webextension will be zipped as
`katex-riot.zip` and the file structure of the extionsion is
written to the folder `katex-riot-pub` for debugging