Skip to content

fix(hugo): preserve $...$ inline math through Goldmark passthrough #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
inful merged 3 commits into from
Jun 12, 2026
Merged

fix(hugo): preserve $...$ inline math through Goldmark passthrough #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2949bd2
fix(hugo): preserve $...$ inline math through Goldmark passthrough
inful Jun 12, 2026
0401ce2
docs(relearn): document math delimiters and $-escape requirement
inful Jun 12, 2026
780325a
docs(relearn): refresh frontmatter fingerprint after math section
inful Jun 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 25 additions & 2 deletions docs/how-to/use-relearn-theme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ categories:
- how-to
date: 2025-12-15T00:00:00Z
description: Relearn theme overview
fingerprint: cad2b47a3afbbaf3e8f319d590ab1cf4d438535b3359485a2f8ca82a61db435e
lastmod: "2026-01-22"
fingerprint: 39f4157cdb927c0f651edabb9972670c6f58507b3f9bc8ec6d8e6e5f77d4ecaf
lastmod: "2026-06-12"
tags:
- themes
- relearn
Expand Down Expand Up @@ -275,6 +275,29 @@ DocBuilder automatically configures these defaults for Relearn:

All defaults can be overridden in your configuration's `hugo.params` section.

## Math Support

Relearn renders mathematical notation through MathJax. DocBuilder wires up the standard delimiter pairs so the following forms all work out of the box:

| Form | Type | Example |
|------|------|---------|
| `$x + y$` | inline | The sum $x + y$ is positive. |
| `\(x + y\)` | inline | The sum \(x + y\) is positive. |
| `$$x + y$$` | display (block) | $$x + y$$ |
| `\[x + y\]` | display (block) | \[x + y\] |

### Escaping literal `$` characters

The `$...$` form is recognised as math whenever a paired `$` is found, so prose that contains a `$` character (currency, shell variables, etc.) will be misread as math. Escape a literal `$` with a backslash when it is **not** meant to start a math span:

```markdown
It costs \$5 and \$10.

Use \$HOME or \$TMPDIR for paths.
```

If you cannot escape at the source (for example, the `$` appears inside a code-incompatible position), wrap the text in inline code with backticks (`` `$HOME` ``).

## Hugo Module Configuration

DocBuilder uses Hugo Modules to automatically install Relearn. The theme is configured as:
Expand Down
2 changes: 1 addition & 1 deletion internal/hugo/models/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ func (rc *RootConfig) EnableMathPassthrough() {
ext["passthrough"] = map[string]any{
"delimiters": map[string]any{
"block": [][]string{{"\\[", "\\]"}, {"$$", "$$"}},
"inline": [][]string{{"\\(", "\\)"}},
"inline": [][]string{{"\\(", "\\)"}, {"$", "$"}},
},
"enable": true,
}
Expand Down
2 changes: 2 additions & 0 deletions internal/hugo/testdata/hugo_config/relearn_custom_taxonomies.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ markup:
inline:
- - \(
- \)
- - $
- $
enable: true
parser:
attribute:
Expand Down
2 changes: 2 additions & 0 deletions internal/hugo/testdata/hugo_config/relearn_default_taxonomies.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ markup:
inline:
- - \(
- \)
- - $
- $
enable: true
parser:
attribute:
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/golden/conflicting-paths/hugo-config.golden.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ markup:
inline:
- - \(
- \)
- - $
- $
enable: true
parser:
attribute:
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/golden/cross-repo-links/hugo-config.golden.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ markup:
inline:
- - \(
- \)
- - $
- $
enable: true
parser:
attribute:
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/golden/daemon-public-filter/hugo-config.golden.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ markup:
inline:
- - \(
- \)
- - $
- $
enable: true
parser:
attribute:
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/golden/deep-nesting/hugo-config.golden.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ markup:
inline:
- - \(
- \)
- - $
- $
enable: true
parser:
attribute:
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/golden/frontmatter-injection/hugo-config.golden.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ markup:
inline:
- - \(
- \)
- - $
- $
enable: true
parser:
attribute:
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/golden/image-paths/hugo-config.golden.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ markup:
inline:
- - \(
- \)
- - $
- $
enable: true
parser:
attribute:
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/golden/malformed-frontmatter/hugo-config.golden.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ markup:
inline:
- - \(
- \)
- - $
- $
enable: true
parser:
attribute:
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/golden/menu-generation/hugo-config.golden.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ markup:
inline:
- - \(
- \)
- - $
- $
enable: true
parser:
attribute:
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/golden/only-readme/hugo-config.golden.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ markup:
inline:
- - \(
- \)
- - $
- $
enable: true
parser:
attribute:
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/golden/section-indexes/hugo-config.golden.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ markup:
inline:
- - \(
- \)
- - $
- $
enable: true
parser:
attribute:
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/golden/sidebar-group-by-multi-value/hugo-config.golden.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ markup:
inline:
- - \(
- \)
- - $
- $
enable: true
parser:
attribute:
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/golden/sidebar-group-by-sibling-category/hugo-config.golden.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ markup:
inline:
- - \(
- \)
- - $
- $
enable: true
parser:
attribute:
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/golden/sidebar-group-by/hugo-config.golden.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ markup:
inline:
- - \(
- \)
- - $
- $
enable: true
parser:
attribute:
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/golden/special-chars/hugo-config.golden.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ markup:
inline:
- - \(
- \)
- - $
- $
enable: true
parser:
attribute:
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/golden/two-repos/hugo-config.golden.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ markup:
inline:
- - \(
- \)
- - $
- $
enable: true
parser:
attribute:
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/golden/uid-permalink-ref/hugo-config.golden.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ markup:
inline:
- - \(
- \)
- - $
- $
enable: true
parser:
attribute:
Expand Down
2 changes: 2 additions & 0 deletions test/testdata/golden/unicode-names/hugo-config.golden.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ markup:
inline:
- - \(
- \)
- - $
- $
enable: true
parser:
attribute:
Expand Down
Loading