hugo: use render hooks for blockquotes (callouts/alerts) #20608
Merged
Conversation
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
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
dvdksn
force-pushed
the
callouts-render-hook
branch
from
20c2734 to
3316ba1
Compare
dvdksn
force-pushed
the
callouts-render-hook
branch
2 times, most recently
from
cb17acb to
d36dbed
Compare
github-actions
bot
added
area/engine
dvdksn
force-pushed
the
callouts-render-hook
branch
from
d36dbed to
ae4aeb4
Compare
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
The shortcut syntax is used by GitHub-style alerts and trigger a lint warning. Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
dvdksn
force-pushed
the
callouts-render-hook
branch
2 times, most recently
from
59c13cf to
4e6fafe
Compare
dvdksn
requested review from
aevesdocker,
craig-osterhout and
crazy-max
as code owners
dvdksn
force-pushed
the
callouts-render-hook
branch
from
4e6fafe to
46ad127
Compare
dvdksn
changed the title
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Instead of inserting the raw file contents, use the page object. Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
dvdksn
force-pushed
the
callouts-render-hook
branch
from
46ad127 to
eb8614a
Compare
aevesdocker
approved these changes
Aug 16, 2024
This was referenced Aug 16, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Trying out the new render hooks functionality for blockquotes in Hugo v0.132.0, for generating custom blockquotes markup to display callouts.
The new syntax for alerts is:
The alert types are hard-coded to be compatible with GitHub's alert types. The following alerts are supported:
notetipimportantwarningcautionThis is in contrast to the callouts we currently use, which are:
notetipimportantwarningexperimentalrestrictedExamples:
The new callouts do not use any custom CSS outside what's in the template, which is an improvement for maintainability. (The icon rendering with the CSS-only solution we use today is especially hacky.)
Appearance-wise, I have changed the callouts to align more with what they look like on GitHub too, e.g. removing the background color.
To migrate to these new alerts, we'd need to:
or add support in the render hook for these classes specifically and keep the current syntax**Note**etc but still defaulted to rendering as notes)