mirror of
https://github.com/thegeeklab/hugo-geekdoc.git
synced 2024-11-25 14:20:42 +00:00
Robert Kaussow
f6966b8513
BREAKING CHANGE: The types of the `hint` short code have been renamed to `[note|tip|important|caution|warning]` the old types `[info|ok|warning|danger]` are still working, but should be considered as deprecated.
BREAKING CHANGE: The `hint` short code is using named arguments now. You have to change, e.g. `{{< hint warning >}}` to `{{< hint type=warning >}}`.
73 lines
1.8 KiB
Plaintext
73 lines
1.8 KiB
Plaintext
+++
|
|
title = "Admonitions"
|
|
+++
|
|
|
|
:toc:
|
|
:toclevels: 2
|
|
|
|
{{< toc >}}
|
|
|
|
== Admonition types
|
|
|
|
There are certain statements you may want to draw attention to by taking them out of the content's flow and labeling them with a priority. These are called admonitions.
|
|
|
|
```tpl
|
|
[NOTE|TIP|IMPORTANT|CAUTION|WARNING]
|
|
Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture.
|
|
Ornateness bland it ex enc, est yeti am bongo detract re.
|
|
```
|
|
|
|
=== Example
|
|
|
|
[NOTE]
|
|
Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture.
|
|
Ornateness bland it ex enc, est yeti am bongo detract re.
|
|
|
|
[TIP]
|
|
Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture.
|
|
Ornateness bland it ex enc, est yeti am bongo detract re.
|
|
|
|
[IMPORTANT]
|
|
Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture.
|
|
Ornateness bland it ex enc, est yeti am bongo detract re.
|
|
|
|
[CAUTION]
|
|
Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture.
|
|
Ornateness bland it ex enc, est yeti am bongo detract re.
|
|
|
|
[WARNING]
|
|
Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture.
|
|
Ornateness bland it ex enc, est yeti am bongo detract re.
|
|
|
|
|
|
== Admonition icons
|
|
|
|
Icons can be added by setting a unicode glyph or a character reference to the `tip-caption` attribute:
|
|
|
|
```text
|
|
:tip-caption: 💡
|
|
|
|
[TIP]
|
|
It's possible to use Unicode glyphs as admonition icons.
|
|
```
|
|
|
|
```text
|
|
:tip-caption: pass:[🔥]
|
|
|
|
[TIP]
|
|
It's possible to use Unicode glyphs as admonition icons.
|
|
```
|
|
|
|
=== Example
|
|
|
|
:tip-caption: 💡
|
|
|
|
[TIP]
|
|
It's possible to use Unicode glyphs as admonition icons.
|
|
|
|
|
|
:tip-caption: pass:[🔥]
|
|
|
|
[TIP]
|
|
It's possible to use Unicode glyphs as admonition icons.
|