2021-07-01 09:05:26 +02:00
|
|
|
---
|
|
|
|
title: Hints
|
|
|
|
---
|
|
|
|
|
2020-01-12 15:33:02 +01:00
|
|
|
Hint shortcode can be used as hint/alerts/notification block.
|
2022-04-23 15:14:42 +02:00
|
|
|
|
2022-07-11 20:45:55 +02:00
|
|
|
## Attributes
|
2022-04-23 15:14:42 +02:00
|
|
|
|
2022-07-11 20:45:55 +02:00
|
|
|
| Name | Description | default |
|
|
|
|
| ---------------- | -------------------------------------------------------------------------------- | --------- |
|
|
|
|
| type | hint type | note |
|
|
|
|
| icon (optional) | custom icon to use,need to be an icon from an [SVG sprite](/features/icon-sets/) | undefined |
|
|
|
|
| title (optional) | hint title | undefined |
|
2022-04-23 15:14:42 +02:00
|
|
|
|
2022-07-11 20:45:55 +02:00
|
|
|
## Usage
|
2020-01-12 15:33:02 +01:00
|
|
|
|
2022-01-06 13:58:10 +01:00
|
|
|
<!-- prettier-ignore-start -->
|
2020-01-12 15:33:02 +01:00
|
|
|
```tpl
|
2022-04-23 15:14:42 +02:00
|
|
|
{{</* hint type=[note|tip|important|caution|warning] (icon=gdoc_github) (title=GitHub) */>}}
|
2020-01-16 11:40:38 +01:00
|
|
|
**Markdown content**\
|
2020-05-31 18:17:32 +02:00
|
|
|
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.
|
2020-01-12 15:33:02 +01:00
|
|
|
{{</* /hint */>}}
|
|
|
|
```
|
2022-01-06 13:58:10 +01:00
|
|
|
<!-- prettier-ignore-end -->
|
2020-01-12 15:33:02 +01:00
|
|
|
|
|
|
|
## Example
|
|
|
|
|
2022-04-23 15:14:42 +02:00
|
|
|
{{< hint type=note >}}
|
|
|
|
**Markdown content**\
|
|
|
|
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.
|
|
|
|
{{< /hint >}}
|
|
|
|
|
|
|
|
{{< hint type=tip >}}
|
2020-01-16 11:40:38 +01:00
|
|
|
**Markdown content**\
|
2020-05-31 18:17:32 +02:00
|
|
|
Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture.
|
2020-09-10 22:23:24 +02:00
|
|
|
Ornateness bland it ex enc, est yeti am bongo detract re.
|
2020-01-12 15:33:02 +01:00
|
|
|
{{< /hint >}}
|
|
|
|
|
2022-04-23 15:14:42 +02:00
|
|
|
{{< hint type=important >}}
|
2020-12-22 13:45:25 +01:00
|
|
|
**Markdown content**\
|
|
|
|
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.
|
|
|
|
{{< /hint >}}
|
|
|
|
|
2022-04-23 15:14:42 +02:00
|
|
|
{{< hint type=caution >}}
|
2020-01-16 11:40:38 +01:00
|
|
|
**Markdown content**\
|
2020-05-31 18:17:32 +02:00
|
|
|
Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture.
|
2020-09-10 22:23:24 +02:00
|
|
|
Ornateness bland it ex enc, est yeti am bongo detract re.
|
2020-01-12 15:33:02 +01:00
|
|
|
{{< /hint >}}
|
|
|
|
|
2022-04-23 15:14:42 +02:00
|
|
|
{{< hint type=warning >}}
|
2020-01-16 11:40:38 +01:00
|
|
|
**Markdown content**\
|
2020-05-31 18:17:32 +02:00
|
|
|
Dolor sit, sumo unique argument um no. Gracie nominal id xiv. Romanesque acclimates investiture.
|
2020-09-10 22:23:24 +02:00
|
|
|
Ornateness bland it ex enc, est yeti am bongo detract re.
|
2020-01-12 15:33:02 +01:00
|
|
|
{{< /hint >}}
|
2022-04-23 15:14:42 +02:00
|
|
|
|
|
|
|
Example with a custom icon and title:
|
|
|
|
|
|
|
|
<!-- prettier-ignore-start -->
|
|
|
|
<!-- spellchecker-disable -->
|
|
|
|
{{< hint type=note icon=gdoc_github title=GitHub >}}
|
|
|
|
**Markdown content**\
|
|
|
|
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.
|
|
|
|
{{< /hint >}}
|
|
|
|
<!-- spellchecker-enable -->
|
|
|
|
<!-- prettier-ignore-end -->
|