From d198d96b304e7afcead78cd8238c79fbabdeeed9 Mon Sep 17 00:00:00 2001 From: Justin Date: Fri, 22 May 2020 01:35:31 -0700 Subject: Enabling KaTex Instructions (#217) * Enabling KaTex Instructions This would have been really helpful if that was documented, many users aren't able to render the KaTex and aren't sure why/where to look Also, fixed spelling some spelling * Update README.md Co-authored-by: Alex Shpak --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 3980d42..b41cd31 100644 --- a/README.md +++ b/README.md @@ -259,7 +259,7 @@ To enable plugin add `@import "plugins/{name}";` to `assets/_custom.scss` in you ### Hugo Internal Templates -There are few hugo tempaltes inserted in `` +There are few hugo templates inserted in `` - [Google Analytics](https://gohugo.io/templates/internal/#google-analytics) - [Open Graph](https://gohugo.io/templates/internal/#open-graph) @@ -273,6 +273,14 @@ There are few hugo tempaltes inserted in `` - [KaTeX](https://themes.gohugo.io/theme/hugo-book/docs/shortcodes/katex/) - [Mermaid](https://themes.gohugo.io/theme/hugo-book/docs/shortcodes/mermaid/) - [Tabs](https://themes.gohugo.io/theme/hugo-book/docs/shortcodes/tabs/) + +By default, Goldmark trims unsafe output which might prevent some shortcodes from rendeting. It's recommended to set `markup.goldmark.renderer.unsafe=true` in case of problems. + +```toml +[markup.goldmark.renderer] + unsafe = true +``` +If you are using ```config.yaml``` or ```config.json```, consult [configuration markup](https://gohugo.io/getting-started/configuration-markup/) ## Versioning -- cgit v1.2.3