Skip to content

Commit 40585fd

Browse files
committed
Add examples for using blockquote alerts
Signed-off-by: chibbyalucard <[email protected]>
1 parent e1870d0 commit 40585fd

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,30 @@ icon:
117117
---
118118
```
119119

120+
##### Highlighting Important Content
121+
122+
> [!NOTE]
123+
> You can highlight important information in your articles or docs using different types of callouts (also known as admonitions – or alerts, as used in [the Hugo docs](https://gohugo.io/render-hooks/blockquotes/#alerts)).
124+
125+
The examples below use the same syntax as in Github Markdown. The template responsible for rendering them is at `site\layouts\_default\_markup\render-blockquote.html:`
126+
127+
```
128+
> [!NOTE]
129+
> Useful information that users should know, even when skimming content.
130+
131+
> [!TIP]
132+
> Helpful advice for doing things better or more easily.
133+
134+
> [!IMPORTANT]
135+
> Key information users need to know to achieve their goal.
136+
137+
> [!WARNING]
138+
> Urgent info that needs immediate user attention to avoid problems.
139+
140+
> [!CAUTION]
141+
> Advises about risks or negative outcomes.
142+
```
143+
120144
#### Layouts
121145
For controlling what HTML is rendered, you need to work with the site templates. In the directory, `site/layouts/`, you'll find a number of HTML files with various template tags. The first file to check out is `site/layouts/_default/baseof.html` - this is the base layout Hugo uses to build your site that templates extend. Hugo has a lookup order for associating a content entry to a template. A single entry whose type is post (`type: post`), Hugo will look for a layout in `site/layouts/post/single.html`, and if that does not exist, it will fallback to `site/layouts/_default/single.html`.
122146

0 commit comments

Comments
 (0)