mirror of
https://github.com/nunocoracao/blowfish.git
synced 2026-01-30 15:31:52 +00:00
docs: update docs for admonitions
This commit is contained in:
@@ -64,6 +64,36 @@ This is an error!
|
||||
|
||||
<br/><br/><br/>
|
||||
|
||||
## Admonition
|
||||
|
||||
Admonitions allow you to insert eye-catching callout boxes in your content.
|
||||
|
||||
Admonitions serve a similar purpose as the alert shortcode but are implemented via Hugo render hooks. The key difference is syntax: admonitions use Markdown syntax, making them more portable across different platforms, whereas shortcodes are specific to Hugo. The syntax resembles GitHub alerts:
|
||||
|
||||
```md
|
||||
> [!NOTE]
|
||||
> A Note type admonition.
|
||||
|
||||
> [!TIP]+ Custom Title
|
||||
> A collapsible admonition with custom title.
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> A Note type admonition.
|
||||
|
||||
> [!TIP]+ Custom Title
|
||||
> A collapsible admonition with custom title.
|
||||
|
||||
The alert sign (`+` or `-`) is optional to control whether the admonition is folded or not. Note that alert sign is only compatible in Obsidian.
|
||||
|
||||
> [!INFO]- Supported types
|
||||
> Valid admonition types include [GitHub alert types](https://github.blog/changelog/2023-12-14-new-markdown-extension-alerts-provide-distinctive-styling-for-significant-content/) and [Obsidian callout types](https://help.obsidian.md/callouts). The types are case-insensitive.
|
||||
>
|
||||
> **GitHub types:** `NOTE`, `TIP`, `IMPORTANT`, `WARNING`, `CAUTION`
|
||||
> **Obsidian types:** `note`, `abstract`, `info`, `todo`, `tip`, `success`, `question`, `warning`, `failure`, `danger`, `bug`, `example`, `quote`
|
||||
|
||||
<br/><br/><br/>
|
||||
|
||||
## Article
|
||||
|
||||
`Article` will embed a single article into a markdown file. The `link` to the file should be the `.RelPermalink` of the file to be embedded. Note that the shortcode will not display anything if it's referencing it's parent. *Note: if you are running your website in a subfolder like Blowfish (i.e. /blowfish/) please include that path in the link.*
|
||||
|
||||
Reference in New Issue
Block a user