📝 Add mathematical notation docs

This commit is contained in:
James Panther
2021-11-04 10:08:59 +11:00
parent 554ae35e6f
commit 67aa482ff6
3 changed files with 66 additions and 47 deletions
+20
View File
@@ -111,6 +111,26 @@ Icons are populated using Hugo pipelines which makes them very flexible. Congo s
Icons can also be used in partials by calling the [icon partial]({{< ref "partials#icon" >}}).
## Katex
The `katex` shortcode can be used to add mathematical expressions to article content using the KaTeX package. Refer to the online reference of [supported TeX functions](https://katex.org/docs/supported.html) for the available syntax.
To include mathematical expressions in an article, simply place the shortcode anywhere with the content. It only needs to be included once per article and KaTeX will automatically render any markup on that page. Both inline and block notation are supported.
Inline notation can be generated by wrapping the expression in `\\(` and `\\)` delimiters. Alternatively, block notation can be generated using `$$` delimiters.
**Example:**
```md
{{</* katex */>}}
\\(f(a,b,c) = (a^2+b^2+c^2)^3\\)
```
{{< katex >}}
\\(f(a,b,c) = (a^2+b^2+c^2)^3\\)
Check out the [mathematical notation samples]({{< ref "mathematical-notation" >}}) page for more examples.
## Lead
`lead` is used to bring emphasis to the start of an article. It can be used to style an introduction, or to call out an important piece of information. Simply wrap any Markdown content in the `lead` shortcode.