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