From 123800f80efea543a53df4915654cb3e0446c90b Mon Sep 17 00:00:00 2001 From: Stephan Lachnit Date: Sun, 16 Oct 2022 17:32:02 +0200 Subject: [PATCH] feature: add support for GLFM math blocks (#987) * feature: add support for GLFM math blocks This add supports for GLFM's math blocks [1] using hugo's Markdown render hooks [2]. [1]: https://docs.gitlab.com/ee/user/markdown.html#math [2]: https://gohugo.io/templates/render-hooks/#render-hooks-for-code-blocks Signed-off-by: Stephan Lachnit --- .../_default/_markup/render-codeblock-math.html | 16 ++++++++++++++++ .../diagrams-and-formulae/index.md | 15 +++++++++++++-- 2 files changed, 29 insertions(+), 2 deletions(-) create mode 100644 layouts/_default/_markup/render-codeblock-math.html diff --git a/layouts/_default/_markup/render-codeblock-math.html b/layouts/_default/_markup/render-codeblock-math.html new file mode 100644 index 0000000000..831b9a2f6b --- /dev/null +++ b/layouts/_default/_markup/render-codeblock-math.html @@ -0,0 +1,16 @@ +{{/* set default delimiters */}} +{{ $delimiter_left := "$$" }} +{{ $delimiter_right := "$$" }} + +{{/* override delimiters if set in config file */}} +{{ with $.Page.Site.Params.katex.options.delimiters }} + {{ range first 1 ( where . "display" true ) }} + {{ $delimiter_left = index . "left" }} + {{ $delimiter_right = index . "right" }} + {{ end }} +{{end}} + +{{/* output of equation */}} +

{{ $delimiter_left }} +{{ .Inner | safeHTML }} +{{ $delimiter_right }}

diff --git a/userguide/content/en/docs/adding-content/diagrams-and-formulae/index.md b/userguide/content/en/docs/adding-content/diagrams-and-formulae/index.md index 859ed7e9a0..94d81b5c5d 100644 --- a/userguide/content/en/docs/adding-content/diagrams-and-formulae/index.md +++ b/userguide/content/en/docs/adding-content/diagrams-and-formulae/index.md @@ -29,11 +29,22 @@ The following code sample produces an introductory text line followed by a formu ```tex The probability of getting \\(k\\) heads when flipping \\(n\\) coins is: -$$\tag*{(1)} P(E) = {n \choose k} p^k (1-p)^{n-k}$$ +$$ +\tag*{(1)} P(E) = {n \choose k} p^k (1-p)^{n-k} +$$ ``` The probability of getting \\(k\\) heads when flipping \\(n\\) coins is: -$$\tag*{(1)} P(E) = {n \choose k} p^k (1-p)^{n-k}$$ +$$ +\tag*{(1)} P(E) = {n \choose k} p^k (1-p)^{n-k} +$$ + +You can also use [GLFM's math blocks](https://docs.gitlab.com/ee/user/markdown.html#math) (requires hugo 0.93 or newer): +````markdown +```math +\tag*{(1)} P(E) = {n \choose k} p^k (1-p)^{n-k} +``` +```` {{% alert title="Tip" %}} This [wiki page](https://en.wikibooks.org/wiki/LaTeX/Mathematics) provides in-depth information about typesetting mathematical formulae using the \\(\LaTeX\\) typesetting system.