aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: b84af510d3d5588d6c7680802e6d4b6a9a408643 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
<!-- SPDX-License-Identifier: GPL-2.0-only -->

# ASAP

A Web extension that adds Markdown and LaTeX support to Pronto.

To bundle the extension, run `nix build` in the root of this repository.  The
result and dependency licenses will appear at `result/asap.zip` and
`result/licenses.txt`.

## Guide

[GFM](https://github.github.com/gfm) is supported.

A pair of `$` invokes KaTeX inline and a pair of `$$` invokes KaTeX inline or in
display mode (depending on whether the two `$$` each have their own line).  For
example,

```tex
This is text and $\pi \in \mathbb R$. Also, $$1 + 1 = 2$$.
$$
\begin{align*}
\sum_{n = 1}^{10} n & = \frac{10 \cdot 11} 2 \\
& = 55
\end{align*}
$$
```

A code block with `math` as the language also invokes display mode:

````md
```math
\begin{align}
& x + y = x \nonumber \\
\implies & y = 0
\end{align}
```
````

## Development

The extension can be tested by [temporarily installing it in
Firefox](about:debugging#/runtime/this-firefox) or by [installing it in
Chromium-based browsers](chrome://extensions).

## License

The files in this repository (except `COPYING`) are licensed under the GNU
General Public License v2.0 only, a copy of which exists in `COPYING`.