mirror of
https://github.com/imfing/hextra.git
synced 2025-08-23 07:07:06 -04:00
docs: add alerts instructions to markdown
This commit is contained in:
@@ -35,6 +35,44 @@ Blockquote with attribution
|
|||||||
[^1]: The above quote is excerpted from Rob Pike's [talk](https://www.youtube.com/watch?v=PAAkCSZUG1c) during Gopherfest, November 18, 2015.
|
[^1]: The above quote is excerpted from Rob Pike's [talk](https://www.youtube.com/watch?v=PAAkCSZUG1c) during Gopherfest, November 18, 2015.
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Alerts
|
||||||
|
|
||||||
|
Alerts are a Markdown extension based on the blockquote syntax that you can use to emphasize critical information.
|
||||||
|
[GitHub-style alerts](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts) are supported.
|
||||||
|
Please make sure you are using the latest version of Hextra and [Hugo v0.134.0](https://github.com/gohugoio/hugo/releases/tag/v0.134.0) or later.
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> Useful information that users should know, even when skimming content.
|
||||||
|
|
||||||
|
> [!TIP]
|
||||||
|
> Helpful advice for doing things better or more easily.
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> Key information users need to know to achieve their goal.
|
||||||
|
|
||||||
|
> [!WARNING]
|
||||||
|
> Urgent info that needs immediate user attention to avoid problems.
|
||||||
|
|
||||||
|
> [!CAUTION]
|
||||||
|
> Advises about risks or negative outcomes of certain actions.
|
||||||
|
|
||||||
|
```markdown {filename=Markdown}
|
||||||
|
> [!NOTE]
|
||||||
|
> Useful information that users should know, even when skimming content.
|
||||||
|
|
||||||
|
> [!TIP]
|
||||||
|
> Helpful advice for doing things better or more easily.
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
> Key information users need to know to achieve their goal.
|
||||||
|
|
||||||
|
> [!WARNING]
|
||||||
|
> Urgent info that needs immediate user attention to avoid problems.
|
||||||
|
|
||||||
|
> [!CAUTION]
|
||||||
|
> Advises about risks or negative outcomes of certain actions.
|
||||||
|
```
|
||||||
|
|
||||||
### Tables
|
### Tables
|
||||||
|
|
||||||
Tables aren't part of the core Markdown spec, but Hugo supports them out-of-the-box.
|
Tables aren't part of the core Markdown spec, but Hugo supports them out-of-the-box.
|
||||||
|
Reference in New Issue
Block a user