summaryrefslogtreecommitdiff
path: root/software/web/src.md
diff options
context:
space:
mode:
Diffstat (limited to 'software/web/src.md')
-rw-r--r--software/web/src.md33
1 files changed, 22 insertions, 11 deletions
diff --git a/software/web/src.md b/software/web/src.md
index 37533f6..53fa14d 100644
--- a/software/web/src.md
+++ b/software/web/src.md
@@ -16,7 +16,7 @@ The script may be executed with a single argument corresponding to the webpage d
./md.sh <target directory>
```
-Alternatively, the script may be given two arguments, pointing to the input file and output file paths respectively.
+Alternatively, the script may be given two arguments consisting of the input and output file paths respectively.
```
./md.sh <input md> <output html>
@@ -40,9 +40,28 @@ Page options are denoted by any combination of the following characters:
- `c`, to generate a table of contents;
- `f`, to suppress generation of the page footer;
-- `h`, to suppress generation of the page header.
+- `h`, to suppress generation of the page header,
+- `m`, to enable math rendering (see below).
-The table of contents generation may malfunction if two header names are identical within the page.
+The table of contents generation may malfunction if two headers within the page have identical names.
+
+## Math Rendering
+
+The rendering of LaTeX math mode expressions given within input files may be enabled by adding the `m` option. This depends on an installation of [KaTeX](https://katex.org) via `npm`.
+
+Block expressions are declared as follows:
+
+```
+![...](%tex)
+```
+
+Inline expressions are declared as follows:
+
+```
+![...](%itex)
+```
+
+where `...` is the LaTeX expression.
# plain.sh
@@ -61,14 +80,6 @@ The HTML page title may be specified within the input document using the followi
```
where `...` is the page title.
-# svgtex.sh
-
-`svgtex.sh` renders LaTeX math mode commands as SVG files.
-
-```
-echo "<equation>" | ./svgtex.sh <output path>
-```
-
# Other Tools
## front.sh