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