summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJustin <justin.gwle@gmail.com>2020-05-22 01:35:31 -0700
committerGitHub <noreply@github.com>2020-05-22 10:35:31 +0200
commitd198d96b304e7afcead78cd8238c79fbabdeeed9 (patch)
tree73bbb85067c5d4d9d2a8f60e08d035a4b0042022
parent8edf0aab161b373062e392a1b8ae15ed98e1e5c8 (diff)
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 <alex-shpak@users.noreply.github.com>
-rw-r--r--README.md10
1 files changed, 9 insertions, 1 deletions
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 `<head>`
+There are few hugo templates inserted in `<head>`
- [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 `<head>`
- [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