hiro/riot-katex
1
0
Fork 0
mirror of https://github.com/vale981/riot-katex synced 2025-03-04 08:41:39 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
17 commits 2 branches 2 tags 116 KiB
JavaScript 86.4%
Shell 13.6%
Find a file
Valentin Boettcher 22b734895f pimp readme and build system
2020-04-10 10:16:38 +02:00
icons add icon 2020-04-10 10:15:37 +02:00
.gitignore update gitignore 2020-04-09 16:07:15 +02:00
example.png add donwload info and examples 2020-04-09 18:31:03 +02:00
manifest.json pimp readme and build system 2020-04-10 10:16:38 +02:00
package-lock.json add fonts and docs 2020-04-09 16:06:36 +02:00
package.json pimp readme and build system 2020-04-10 10:16:38 +02:00
package.sh pimp readme and build system 2020-04-10 10:16:38 +02:00
README.md pimp readme and build system 2020-04-10 10:16:38 +02:00
riot-katex.js pimp readme and build system 2020-04-10 10:16:38 +02:00

README.md

Icon 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 for other instances, you have to adjust the manifest.json.

Writing LaTeX

  • $$x^2$$ renders math block style
  • \(x^2\) renders math inline

Download and Installation

You can download the extension from here. Just double click it, or drag it one firefox to install.

Example

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 for providing the blazingly fast rendering library for LaTeX formulas.