Skip to content

Commit

Permalink
docs(admonitions): Update description of nested admonitions
Browse files Browse the repository at this point in the history
  • Loading branch information
niclasheinz committed Jan 3, 2025
1 parent 750fb53 commit 2171aa4
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions docs/reference/admonitions.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,9 +157,8 @@ links, formatting, ...) after the type qualifier:

### nested admonitions

By default, the title will equal the type qualifier in titlecase. However, it
can be changed by adding a quoted string containing valid Markdown (including
links, formatting, ...) after the type qualifier:
You can also include nested admonitions in your documentation. To do this, you
can use your existing admonitions and indent the desired ones:

``` markdown title="Nested Admonition"
!!! note "Outer Note"
Expand Down

0 comments on commit 2171aa4

Please sign in to comment.