Admonitions Material
Admonitions Material
Section titled “Admonitions Material”Syntax
Section titled “Syntax”| Form | Syntax | Usage |
|---|---|---|
| Simple | !!! note | Open block with automatic title. |
| Title | !!! tip "Title" | Custom title. |
| No title | !!! info "" | Hidden title. |
| Details | ??? warning "Title" | Collapsible block. |
| Open details | ???+ danger "Title" | Block open by default. |
| Inline | !!! info inline / !!! tip inline end | Side note. |
| Types | note, abstract, info, tip, success, question, warning, failure, danger, bug, example, quote | Material types. |
| Alias | hint, important, check, done, caution, attention, error, cite | Common aliases. |
Simple syntax
Section titled “Simple syntax”!!! note
Use a simple note to add extra context without interrupting the main reading flow.
!!! note "Custom title"
The title can be replaced with a quoted string to contextualize the message.
!!! note ""
An empty string removes the title when the content is self-explanatory.Open details
Section titled “Open details”??? warning "Details block"
`???` blocks are rendered as `details`, but open by default to keep the desired behavior on this site.
???+ danger "Open details block"
The `???+` variant stays open and keeps the color of the selected type.Details block
??? blocks are rendered as details, but open by default to keep the desired behavior on this site.
Open details block
The ???+ variant stays open and keeps the color of the selected type.
Inline blocks
Section titled “Inline blocks”!!! info inline "Inline left"
This side note floats left. It should be placed before the text that flows beside it.
Text can flow to the right of the inline block when horizontal space is sufficient. On mobile, the block returns to full width to preserve comfortable reading.
!!! tip inline end "Inline right"
This side note floats right.
Text can flow to the left of the `inline end` block. This syntax is useful for short side notes close to the related paragraph.Text can flow to the right of the inline block when horizontal space is sufficient. On mobile, the block returns to full width to preserve comfortable reading.
Text can flow to the left of the inline end block. This syntax is useful for short side notes close to the related paragraph.
Supported types
Section titled “Supported types”!!! note
General information or a short remark.
!!! abstract
Summary, synthesis, or section objective.
!!! info
Useful information for understanding the context.
!!! tip
Tip or practical recommendation.
!!! success
Expected result, validation, or completed step.
!!! question
Frequently asked question or point to verify.
!!! warning
Caution before a potentially sensitive action.
!!! failure
Failure case, unmet condition, or validation problem.
!!! danger
Major risk, data loss, or destructive operation.
!!! bug
Known behavior or anomaly to monitor.
!!! example
Standalone example or configuration excerpt.
!!! quote
Quote, source, or reminder of a convention.Common aliases
Section titled “Common aliases”!!! hint "Alias de tip"
`hint` and `important` use the `tip` rendering.
!!! check "Alias de success"
`check` and `done` use the `success` rendering.
!!! caution "Warning alias"
`caution` and `attention` use the `warning` rendering.
!!! error "Danger alias"
`error` uses the `danger` rendering.
!!! cite "Quote alias"
`cite` uses the `quote` rendering.