mirror of
https://github.com/Brandon-Rozek/website-theme.git
synced 2024-11-09 10:50:34 -05:00
Update example contents
This commit is contained in:
parent
ef9578b083
commit
e148323149
1 changed files with 5 additions and 31 deletions
|
@ -5,42 +5,16 @@ draft: false
|
||||||
math: true
|
math: true
|
||||||
---
|
---
|
||||||
|
|
||||||
Mathematical notation in a Hugo project can be enabled by using third party JavaScript libraries.
|
In this theme we will be using [MathJax 2.7](https://docs.mathjax.org/en/v2.7-latest/index.html)
|
||||||
<!--more-->
|
|
||||||
|
|
||||||
In this example we will be using [KaTeX](https://katex.org/)
|
- To enable MathJax globally set the parameter `math` to `true` in a project's configuration
|
||||||
|
- To enable MathJax on a per page basis include the parameter `math: true` in content files
|
||||||
|
|
||||||
- Create a partial under `/layouts/partials/math.html`
|
**Note:** Use the online reference of [MathJax TeX and LaTeX Support](https://docs.mathjax.org/en/v2.7-latest/tex.html#)
|
||||||
- Within this partial reference the [Auto-render Extension](https://katex.org/docs/autorender.html) or host these scripts locally.
|
|
||||||
- Include the partial in your templates like so:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
{{ if or .Params.math .Site.Params.math }}
|
|
||||||
{{ partial "math.html" . }}
|
|
||||||
{{ end }}
|
|
||||||
```
|
|
||||||
|
|
||||||
- To enable KaTex globally set the parameter `math` to `true` in a project's configuration
|
|
||||||
- To enable KaTex on a per page basis include the parameter `math: true` in content files
|
|
||||||
|
|
||||||
**Note:** Use the online reference of [Supported TeX Functions](https://katex.org/docs/supported.html)
|
|
||||||
|
|
||||||
{{< math.inline >}}
|
|
||||||
{{ if or .Page.Params.math .Site.Params.math }}
|
|
||||||
<!-- KaTeX -->
|
|
||||||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.11.1/dist/katex.min.css" integrity="sha384-zB1R0rpPzHqg7Kpt0Aljp8JPLqbXI3bhnPWROx27a9N0Ll6ZP/+DiW/UqRcLbRjq" crossorigin="anonymous">
|
|
||||||
<script defer src="https://cdn.jsdelivr.net/npm/katex@0.11.1/dist/katex.min.js" integrity="sha384-y23I5Q6l+B6vatafAwxRu/0oK/79VlbSz7Q9aiSZUvyWYIYsd+qj+o24G5ZU2zJz" crossorigin="anonymous"></script>
|
|
||||||
<script defer src="https://cdn.jsdelivr.net/npm/katex@0.11.1/dist/contrib/auto-render.min.js" integrity="sha384-kWPLUVMOks5AQFrykwIup5lo0m3iMkkHrD0uJ4H5cjeGihAutqP0yW0J6dpFiVkI" crossorigin="anonymous" onload="renderMathInElement(document.body);"></script>
|
|
||||||
{{ end }}
|
|
||||||
{{</ math.inline >}}
|
|
||||||
|
|
||||||
### Examples
|
### Examples
|
||||||
|
|
||||||
{{< math.inline >}}
|
Inline math: $\varphi = \dfrac{1+\sqrt5}{2}= 1.6180339887…$
|
||||||
<p>
|
|
||||||
Inline math: \(\varphi = \dfrac{1+\sqrt5}{2}= 1.6180339887…\)
|
|
||||||
</p>
|
|
||||||
{{</ math.inline >}}
|
|
||||||
|
|
||||||
Block math:
|
Block math:
|
||||||
$$
|
$$
|
||||||
|
|
Loading…
Reference in a new issue