Update configuration-markup.md: remove ambiguity #2872
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add double quotes around the names, otherwise I read it twice as a verb there.
jmooring
requested changes
Feb 7, 2025
There was a problem hiding this comment.
Thanks for pointing this out. I think this was written during development of the subscript/superscript/mark/delete/insert capabilities, where each was a separate extension. At some point we bundled these features into one extension: Extras.
So I think when we refer to an extension it should be capitalized, but quote a feature (see my suggestion). Or maybe place within backticks.
| @@ -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" extension, if you want to render subscript and strikethrough text concurrently you must: | |||
There was a problem hiding this comment.
Suggested change
| 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 |
There was a problem hiding this comment.
Suggested change
| 1. Disable the Goldmark "strikethrough" extension | |
| 1. Disable the Goldmark Strikethrough extension |
| 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 |
There was a problem hiding this comment.
Suggested change
| 1. Enable the Hugo Goldmark Extras "delete" extension | |
| 1. Enable the Hugo Goldmark Extras "delete" feature |
| @@ -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. | |||
There was a problem hiding this comment.
Suggested change
| 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. |
jmooring: > I think this was written during development of the subscript/superscript/mark/delete/insert capabilities, where each was a separate extension. At some point we bundled these features into one extension: Extras. > So I think when we refer to an extension it should be capitalized, but quote a feature (see my suggestion). Or maybe place within backticks.
|
Thanks for explaining, I have applied your exact suggestion. I've also grepped the docs PS: The link references like |
jmooring
requested changes
Feb 7, 2025
| 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 |
There was a problem hiding this comment.
Suggested change
| 1. Enable the Hugo Goldmark Extras Delete extension | |
| 1. Enable the Hugo Goldmark Extras "delete" feature |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add double quotes around the names, otherwise I read it twice as a verb there.
Although a couple paragraphs above the names are capitalized (if you care about consistency) I decided not to change them, because capitalization is appropriate there.