Treewide: Convert Hugo callouts to GFM alerts#1269
Merged
fufexan merged 4 commits intohyprwm:mainfrom Nov 1, 2025
Merged
Conversation
This was missed because the type was enclosed in quotes
Contributor
Author
|
Ok, will mark as ready for merge once I skimmed all the pages |
- Alerts that contained a heading have been changed so that the "heading" now appears in place of the alert title. The alert icon and color still reflect the alert type. - Removed unneccessary blank space.
Contributor
Author
|
Ready for merge |
This file contains hidden or 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
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.
This converts all the Hugo style callouts to GFM alerts.
For example, this
{{< callout type=info >}} To get the correct name for an `unmodified_key`, refer to [the section on uncommon syms](#uncommon-syms--binding-with-a-keycode) {{< /callout >}}gets converted to:
This is related to #1198 and it's meant make the codebase easier to lint by using standard markdown where possible, reducing Hugo specific markup to a minimum.
Some notes on the automated conversion that has been performed:
warning,importantandinfogot converted to[!WARNING],[!IMPORTANT]and[!NOTE]respectively.[!WARNING]by default, since they were highlighted in orange by Hugo. This will maintain visual continuity.{{< callout type=warning >}}) and before the closing markup ({{</ callout >}}) were trimmed.I'll include the script that I used here for documenation's sake, but let me know if I should push it to the repo:
(Can just be run from the repo's root, without args)
hugo-callouts-to-gfm-alerts.plIf this is merged, we may want to consider adding a note about the new alert style to the
Contributing to the WIkisection the README, to inform contributors about the change. Let me know if you want it mentioned and I'll add it.Marked as draft as I skimmed about 20-25 pages opening them at random to check alerts looked correct, but did not confirm each and every conversion went well, aside from looking at the diff.
An additional pair of eyes is welcomed :)
I'll give a more thorough look to all pages if we decide to go forward with this ✌️