mirror of
https://github.com/alex-shpak/hugo-book.git
synced 2025-06-11 19:24:06 +00:00
updated docs and added to example config
This commit is contained in:
parent
29017f6d82
commit
0d9fcac5a0
@ -15,6 +15,7 @@
|
||||
- [Blog](#blog)
|
||||
- [Configuration](#configuration)
|
||||
- [Shortcodes](#shortcodes)
|
||||
- [Math](#math)
|
||||
- [Versioning](#versioning)
|
||||
- [Contributing](#contributing)
|
||||
|
||||
@ -177,11 +178,11 @@ disableKinds = ['taxonomy', 'taxonomyTerm']
|
||||
# Can be overwritten by same param in page frontmatter
|
||||
BookComments = true
|
||||
|
||||
# (Optional) Enables a Katex math engine that works with the Goldmark markdown
|
||||
# (Optional, default false) Enables a Katex math engine that works with the Goldmark markdown
|
||||
# pass through. This removes the need for shortcodes for math. Also requires
|
||||
# defining the pass through delimiters.
|
||||
# See below.
|
||||
BookKatexMathPassthrough = true
|
||||
BookKatexMathPassthrough = false
|
||||
|
||||
# /!\ This is an experimental feature, might be removed or changed at any time
|
||||
# (Optional, experimental, default false) Enables portable links and link checks in markdown pages.
|
||||
|
@ -104,6 +104,13 @@ enableGitInfo = true
|
||||
# Can be overwritten by same param in page frontmatter
|
||||
BookComments = true
|
||||
|
||||
# (Optional, default false) Enables a Katex math engine that works with the Goldmark markdown
|
||||
# pass through. This removes the need for shortcodes for math. Also requires
|
||||
# defining the pass through delimiters.
|
||||
# See below.
|
||||
BookKatexMathPassthrough = false
|
||||
|
||||
|
||||
# /!\ This is an experimental feature, might be removed or changed at any time
|
||||
# (Optional, experimental, default false) Enables portable links and link checks in markdown pages.
|
||||
# Portable links meant to work with text editors and let you write markdown without {{< relref >}} shortcode
|
||||
|
@ -100,6 +100,14 @@ params:
|
||||
# Can be overwritten by same param in page frontmatter
|
||||
BookComments: true
|
||||
|
||||
|
||||
# (Optional, default false) Enables a Katex math engine that works with the Goldmark markdown
|
||||
# pass through. This removes the need for shortcodes for math. Also requires
|
||||
# defining the pass through delimiters.
|
||||
# See below.
|
||||
BookKatexMathPassthrough: false
|
||||
|
||||
|
||||
# /!\ This is an experimental feature, might be removed or changed at any time
|
||||
# (Optional, experimental, default false) Enables portable links and link checks in markdown pages.
|
||||
# Portable links meant to work with text editors and let you write markdown without {{< relref >}} shortcode
|
||||
|
@ -57,6 +57,6 @@ https://github.com/alex-shpak/hugo-book
|
||||
{{- end -}}
|
||||
|
||||
<!--Katex Partial Injection-->
|
||||
{{ if .Param "BookKatexMathPassthrough" }}
|
||||
{{ if .Site.Param "BookKatexMathPassthrough" }}
|
||||
{{ partialCached "docs/math.html" . }}
|
||||
{{ end }}
|
||||
|
Loading…
Reference in New Issue
Block a user