]> BookStack Code Mirror - hacks/commitdiff
Add LaTeX/MathJax hack 1/head
authorAKP <redacted>
Mon, 27 Feb 2023 11:53:58 +0000 (11:53 +0000)
committerAKP <redacted>
Mon, 27 Feb 2023 11:57:34 +0000 (11:57 +0000)
Signed-off-by: AKP <redacted>
content/mathjax/head.html [new file with mode: 0644]
content/mathjax/index.md [new file with mode: 0644]

diff --git a/content/mathjax/head.html b/content/mathjax/head.html
new file mode 100644 (file)
index 0000000..8a51c03
--- /dev/null
@@ -0,0 +1,9 @@
+<script>
+    MathJax = {
+        tex: {
+            inlineMath: [['$', '$']],
+        },
+    };
+</script>
+<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml-full.js">
+</script>
\ No newline at end of file
diff --git a/content/mathjax/index.md b/content/mathjax/index.md
new file mode 100644 (file)
index 0000000..4605d4a
--- /dev/null
@@ -0,0 +1,36 @@
++++
+title = "Render LaTeX with MathJax"
+author = "@codemicro"
+date = 2023-02-27T00:00:00Z
+updated = 2023-02-27T00:00:00Z
+tested = "v23.02"
++++
+
+This hack will allow LaTeX equations and markup to be rendered within a page on
+Bookstack.
+
+Inline math can be surrounded with `$` and math blocks can be surrounded with 
+`$$`.
+
+This can be used with both the WYSISYG editor and the Markdown editor and will
+affect everything on a given page, meaning this can be used in titles,
+book/chapter headings, etc.
+
+#### Considerations
+
+This loads MathJax the MathJax JavaScript from a CDN, and will do so for every 
+page load.
+
+Live previews of the rendered LaTeX markup will not be rendered in the Markdown
+editor's preview.
+
+Using this markup may create difficulties when using the search engine to find
+certain pages.
+
+#### Options
+
+It is possible to configure MathJax as documented [here](https://docs.mathjax.org/en/latest/web/configuration.html).
+
+#### Code
+
+{{<hack file="head.html" type="head">}}