mirror of
https://github.com/thegeeklab/hugo-geekdoc.git
synced 2024-11-16 09:50:40 +00:00
70 lines
2.5 KiB
Markdown
70 lines
2.5 KiB
Markdown
---
|
|
title: Hints
|
|
---
|
|
|
|
Hint shortcode can be used as hint/alerts/notification block.
|
|
|
|
## Attributes
|
|
|
|
| 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 |
|
|
|
|
## Usage
|
|
|
|
<!-- prettier-ignore-start -->
|
|
```tpl
|
|
{{</* hint type=[note|tip|important|caution|warning] (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 */>}}
|
|
```
|
|
<!-- prettier-ignore-end -->
|
|
|
|
## Example
|
|
|
|
{{< 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 >}}
|
|
**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=important >}}
|
|
**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=caution >}}
|
|
**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=warning >}}
|
|
**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 >}}
|
|
|
|
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 -->
|