MathJax
Create inline SVG images for STEM content.
Background
Asciidoc has macros to include STEM (Science, Technology, Engineering and Math) equations and formulas. When STEM is "activated" on a page, it will include MathJax for client-side rendering of this content.
However, Antora does not include MathJax on STEM-enabled pages.
One way to solve this, is to add a slightly customised solution:
-
Add a page attribute like
page-steminstead ofstem. -
Adapt the UI to include MathJax for pages with this attribute.
We have chosen a different way:
-
Include the @djencks/asciidoctor-mathjax package.
-
Add it as extension to generate inline SVG rendering when producing the site.
The benefit is that this is preserves the Asciidoc STEM macro behaviour. It also keeps the published pages a little lighter.
|
The downside is that it is not possible to copy an equation or formula from the page. Neither the source nor the image itself is selectable. Client-side rendering works better for accessibility. |
Using standard Asciidoc has priority now. [1] We expect that either Antora or the extension will be updated at some point.
Asciidoc seems to favour Asciimath over TeX and LaTeX as default format. It is possible to mix both on a page. It appears that TeX/LaTeX is more widely used in science.
Using STEM (summary)
Optionally activate STEM as attribute in the page header.
| The extension does not require this attribute but will always process STEM blocks. |
= Page title
:stem: (1)| 1 | Default value is asciimath, can also be latexmath. |
Then add either inline or block elements.
This is inline stem:[sqrt(4) = 2].
It can be with explicit format choice:
latexmath:[C = \alpha + \beta Y^{\gamma} + \epsilon].
It can also be put in a block, which will be centered:
[stem]
++++
[[a,b],[c,d]]((n),(k))
sqrt(4) = 2
sqrt(9) = 3
++++This is inline . It can be with explicit format choice: .
It can also be put in a block, which will be centered:
|
Not all is rendered as |