Skip to content

Commit 6b27f26

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

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
@@ -91,6 +91,30 @@ hugo new blog/$(date -v +7d '+%Y-%m-%d')-learning-zap-api/index.md
9191

9292
For keeping content organized you also have the option of encapsulating the content of a post in a directory. If a post has a number of images or other assets related to it, it is much cleaner to include those assets with the post instead of putting them all in the assets directory. For example instead of having `site/content/download.md`, you could have `site/content/download/index.md` & all the post's related images would also live in that same `download` directory.
9393

94+
##### Highlighting Important Content
95+
96+
> [!NOTE]
97+
> 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)).
98+
99+
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:`
100+
101+
```
102+
> [!NOTE]
103+
> Useful information that users should know, even when skimming content.
104+
105+
> [!TIP]
106+
> Helpful advice for doing things better or more easily.
107+
108+
> [!IMPORTANT]
109+
> Key information users need to know to achieve their goal.
110+
111+
> [!WARNING]
112+
> Urgent info that needs immediate user attention to avoid problems.
113+
114+
> [!CAUTION]
115+
> Advises about risks or negative outcomes.
116+
```
117+
94118
##### New Content
95119
For adding new categories of content such as addons or wiki entries follow the pattern below using addons as an example
96120

0 commit comments

Comments
 (0)