riot-katex/README.md

28 lines
826 B
Markdown
Raw Permalink Normal View History

2020-07-19 18:27:22 +02:00
# ![Icon](icons/icon.png) Riot/Element KaTeX
2020-04-09 14:31:27 +02:00
2020-07-19 18:27:22 +02:00
This extension injects KaTeX into the `Element` chat client for
2020-04-10 10:18:32 +02:00
`matrix`.
2020-04-09 14:31:27 +02:00
## Writing LaTeX
2020-04-27 13:09:08 +02:00
- `$$$x^2$$$` renders math block style
- `$$x^2$$` renders math inline
2020-04-09 14:31:27 +02:00
2020-04-09 18:31:03 +02:00
## Download and Installation
2020-04-11 08:10:16 +02:00
You can download the extension [the firefox addon
store](https://addons.mozilla.org/en-US/firefox/addon/riot-katex/).
2020-04-09 18:31:03 +02:00
2020-04-09 18:44:07 +02:00
## Example
![Example](example.png)
2020-04-09 16:06:36 +02:00
## Building the Extension
- make sure you have npm installed
2020-04-10 10:16:38 +02:00
- 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.