Skip to content
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

Update configuration-markup.md: remove ambiguity #2872

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update configuration-markup.md: remove ambiguity #2872

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
2fc5b01
Update configuration-markup.md: remove ambiguity
vadcx Feb 7, 2025
e518983
configuration-markup.md: follow style suggested in review
vadcx Feb 7, 2025
0f7a77e
passthrough.md: consistent capitalization of 'Passthrough extension'
vadcx Feb 7, 2025
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
8 changes: 4 additions & 4 deletions content/en/getting-started/configuration-markup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,10 +104,10 @@ Superscript|`1^st^`|`1<sup>st</sup>`
[subscript]: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/sub
[superscript]: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/sup

To avoid a conflict when enabling the Hugo Goldmark Extras subscript extension, if you want to render subscript and strikethrough text concurrently you must:
To avoid a conflict when enabling the Hugo Goldmark Extras "subscript" feature, if you want to render subscript and strikethrough text concurrently you must:

1. Disable the Goldmark strikethrough extension
1. Enable the Hugo Goldmark Extras delete extension
1. Disable the Goldmark Strikethrough extension
1. Enable the Hugo Goldmark Extras Delete extension
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. Enable the Hugo Goldmark Extras Delete extension
1. Enable the Hugo Goldmark Extras "delete" feature


For example:

Expand All @@ -126,7 +126,7 @@ enable = true

{{< new-in 0.122.0 />}}

Enable the passthrough extension to include mathematical equations and expressions in Markdown using LaTeX markup. See [mathematics in Markdown] for details.
Enable the Passthrough extension to include mathematical equations and expressions in Markdown using LaTeX markup. See [mathematics in Markdown] for details.

[mathematics in Markdown]: content-management/mathematics/

Expand Down
8 changes: 4 additions & 4 deletions content/en/render-hooks/passthrough.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Passthrough render hooks
linkTitle: Passthrough
description: Create a passthrough render hook to override the rendering of text snippets captured by the Goldmark passthrough extension.
description: Create a passthrough render hook to override the rendering of text snippets captured by the Goldmark Passthrough extension.
categories: [render hooks]
keywords: []
menu:
Expand All @@ -16,7 +16,7 @@ toc: true

## Overview

Hugo uses [Goldmark] to render Markdown to HTML. Goldmark supports custom extensions to extend its core functionality. The Goldmark [passthrough extension] captures and preserves raw Markdown within delimited snippets of text, including the delimiters themselves. These are known as _passthrough elements_.
Hugo uses [Goldmark] to render Markdown to HTML. Goldmark supports custom extensions to extend its core functionality. The Goldmark [Passthrough extension] captures and preserves raw Markdown within delimited snippets of text, including the delimiters themselves. These are known as _passthrough elements_.

[Goldmark]: https://github.com/yuin/goldmark
[passthrough extension]: /getting-started/configuration-markup/#passthrough
Expand All @@ -33,7 +33,7 @@ passthrough element with opening and closing block delimiters.
This is an \(inline\) passthrough element with opening and closing inline delimiters.
{{< /code >}}

Update your site configuration to enable the passthrough extension and define opening and closing delimiters for each passthrough element type, either `block` or `inline`. For example:
Update your site configuration to enable the Passthrough extension and define opening and closing delimiters for each passthrough element type, either `block` or `inline`. For example:

{{< code-toggle file=hugo >}}
[markup.goldmark.extensions.passthrough]
Expand All @@ -45,7 +45,7 @@ inline = [['\(', '\)']]

In the example above there are two sets of `block` delimiters. You may use either one in your Markdown.

The Goldmark passthrough extension is often used in conjunction with the MathJax or KaTeX display engine to render [mathematical expressions] written in the LaTeX markup language.
The Goldmark Passthrough extension is often used in conjunction with the MathJax or KaTeX display engine to render [mathematical expressions] written in the LaTeX markup language.

[mathematical expressions]: /content-management/mathematics/

Expand Down