updated docs and added to example config

This commit is contained in:
mtseng15 2025-05-05 16:28:14 -05:00
parent 29017f6d82
commit 0d9fcac5a0
4 changed files with 19 additions and 3 deletions

View File

@ -15,6 +15,7 @@
- [Blog](#blog) - [Blog](#blog)
- [Configuration](#configuration) - [Configuration](#configuration)
- [Shortcodes](#shortcodes) - [Shortcodes](#shortcodes)
- [Math](#math)
- [Versioning](#versioning) - [Versioning](#versioning)
- [Contributing](#contributing) - [Contributing](#contributing)
@ -177,11 +178,11 @@ disableKinds = ['taxonomy', 'taxonomyTerm']
# Can be overwritten by same param in page frontmatter # Can be overwritten by same param in page frontmatter
BookComments = true 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 # pass through. This removes the need for shortcodes for math. Also requires
# defining the pass through delimiters. # defining the pass through delimiters.
# See below. # See below.
BookKatexMathPassthrough = true BookKatexMathPassthrough = false
# /!\ This is an experimental feature, might be removed or changed at any time # /!\ 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. # (Optional, experimental, default false) Enables portable links and link checks in markdown pages.

View File

@ -104,6 +104,13 @@ enableGitInfo = true
# Can be overwritten by same param in page frontmatter # Can be overwritten by same param in page frontmatter
BookComments = true 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 # /!\ 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. # (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 # Portable links meant to work with text editors and let you write markdown without {{< relref >}} shortcode

View File

@ -100,6 +100,14 @@ params:
# Can be overwritten by same param in page frontmatter # Can be overwritten by same param in page frontmatter
BookComments: true 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 # /!\ 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. # (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 # Portable links meant to work with text editors and let you write markdown without {{< relref >}} shortcode

View File

@ -57,6 +57,6 @@ https://github.com/alex-shpak/hugo-book
{{- end -}} {{- end -}}
<!--Katex Partial Injection--> <!--Katex Partial Injection-->
{{ if .Param "BookKatexMathPassthrough" }} {{ if .Site.Param "BookKatexMathPassthrough" }}
{{ partialCached "docs/math.html" . }} {{ partialCached "docs/math.html" . }}
{{ end }} {{ end }}