Merge pull request #113 from daira/katex

Support KaTeX

.github/workflows/merge-acceptance.yaml

@@ -14,6 +14,9 @@ jobs:
     - uses: taiki-e/cache-cargo-install-action@v1
       with:
         tool: [email protected]
+    - uses: taiki-e/cache-cargo-install-action@v1
+      with:
+        tool: [email protected]
     - uses: taiki-e/cache-cargo-install-action@v1
       with:
         tool: [email protected]

.github/workflows/render-site.yaml

@@ -25,6 +25,9 @@ jobs:
     - uses: taiki-e/cache-cargo-install-action@v1
       with:
         tool: [email protected]
+    - uses: taiki-e/cache-cargo-install-action@v1
+      with:
+        tool: [email protected]
     - uses: taiki-e/cache-cargo-install-action@v1
       with:
         tool: [email protected]

README.md

@@ -30,6 +30,7 @@ git config --local core.hooksPath git-hooks
 
 - `cargo install mdbook`
 - `cargo install mdbook-graphviz`
+- `cargo install mdbook-katex`
 - `cargo install mdbook-linkcheck`
 
 ### Other prerequisites

book.toml

@@ -1,5 +1,8 @@
 [book]
-authors = ["Nate Wilcox"]
+authors = [
+    "Nate Wilcox",
+    "Daira Emma Hopwood",
+]
 language = "en"
 multilingual = false
 src = "src"
@@ -13,6 +16,12 @@ title = "Zcash Trailing Finality Layer - v0.1.0"
 # the symlink and then does the move).
 build-dir = "build"
 
+[preprocessor.katex]
+macros = "macros.txt"
+renderer = ["html"]
+# This is needed in order for \href and \url links to work.
+trust = true
+
 [output.html]
 default-theme = "light"
 

macros.txt

@@ -0,0 +1 @@
+\yaykatex:{\mathsf{yay}\;\href{https://katex.org}{\KaTeX}}