Files
foam/docs/math-support.md
2020-07-14 20:50:17 +01:00

1.3 KiB

layout
layout
mathjax

Math Support

The published pages don't support math formulas by default. To enable this feature, you can add the following code snippet to the end of _layouts/page.html:

<script src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script>
<script type="text/x-mathjax-config">
    MathJax.Hub.Config({
        tex2jax: {
            skipTags: ['script', 'noscript', 'style', 'textarea', 'pre'],
            inlineMath: [['$','$']]
        }
    });
</script>

Example of inline math: e^{i \pi}+1=0
Example of displayed math:

f_{\mathbf{X}}\left(x_{1}, \ldots, x_{k}\right)=\frac{\exp \left(-\frac{1}{2}(\mathbf{x}-\boldsymbol{\mu})^{\mathrm{T}} \mathbf{\Sigma}^{-1}(\mathbf{x}-\boldsymbol{\mu})\right)}{\sqrt{(2 \pi)^{k}|\mathbf{\Sigma}|}}

If you want the index page of your Foam site to render maths, you'll need to add that to _layouts/home.html as well, or change the layout of the index page to be "page" instead of "home" by putting this Front Matter on the top of your readme.md/index.md:

---
layout: page
---

# Your normal title here

Reference: How to support latex in github-pages