codinginbarn/bookstack-hacks
Fork 0
forked from bookstack/hacks
Code Pull requests Activity

Updated mathjax hack text after review

Browse source
This commit is contained in:
Dan Brown 2023-03-01 11:34:39 +00:00
commit 07b224bebb
Signed by: danb
GPG key ID: 46D9F943C24A2EF9
2 changed files with 14 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

5
content/mathjax/head.html
View file

@ -1,9 +1,8 @@
<script>
MathJax = {
window.MathJax = {
tex: {
inlineMath: [['$', '$']],
},
};
</script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml-full.js">
</script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml-full.js"></script>

26
content/mathjax/index.md
View file

@ -1,35 +1,33 @@
+++
title = "Render LaTeX with MathJax"
title = "Render TeX/LaTeX Mathematics 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.
This hack will allow TeX/LaTeX mathematic markup to be rendered within a page on
BookStack using [MathJax](https://www.mathjax.org/).
Inline math can be surrounded with `$` and math blocks can be surrounded with
`$$`.
`$$` or `\[...\]`. Additionally LaTeX environments and `\ref{...}` commands will be processed.
This can be used with both the WYSISYG editor and the Markdown editor and will
This can be used with both the WYSIWYG 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.
- This relies on JavaScript to parse and render content on page load.
- This loads MathJax the MathJax JavaScript from an external CDN (jsdelivr.net) server.
- Math rendering may not work in all areas of the application, notedly:
- No rendering in the Markdown live preview.
- No rendering in many export formats, including PDF.
- This could introduce rendering of Math where not intended.
#### Options
It is possible to configure MathJax as documented [here](https://docs.mathjax.org/en/latest/web/configuration.html).
It is possible to further [configure MathJax as documented here](https://docs.mathjax.org/en/latest/web/configuration.html).
#### Code