adoralaura/hugo-book-theme
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Enabling KaTex Instructions (#217)

Browse source 
* 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>
This commit is contained in:
Justin 2020-05-22 01:35:31 -07:00 committed by GitHub
parent 8edf0aab16
commit d198d96b30
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -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)
@ -274,6 +274,14 @@ There are few hugo tempaltes inserted in `<head>`
- [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
Theme follows simple incremental versioning. e.g. `v1`, `v2` and so on. There might be breaking changes between versions.