hugo-geekdoc/exampleSite/content/en/shortcodes/hints.md

70 lines
2.5 KiB
Markdown
Raw Normal View History

---
title: Hints
---
2020-01-12 14:33:02 +00:00
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
2020-01-12 14:33:02 +00:00
<!-- prettier-ignore-start -->
2020-01-12 14:33:02 +00:00
```tpl
{{</* 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 */>}}
```
<!-- prettier-ignore-end -->
2020-01-12 14:33:02 +00:00
## 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 >}}
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 >}}
{{< 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 >}}
{{< 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 >}}
{{< 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 >}}
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 -->