Skip to content

Commit e14f021

Browse files
authored
Document blank lines allowed in admonitions (JuliaDocs#2515)
1 parent d71b378 commit e14f021

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

docs/src/showcase.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,25 +79,30 @@ Documenter supports a range of admonition types for different circumstances.
7979

8080
###### Note admonition
8181
!!! note "'note' admonition"
82+
8283
Admonitions look like this. This is a `!!! note`-type admonition.
8384

84-
Note that admonitions themselves can contain other block-level elements too,
85-
such as code blocks. E.g.
85+
Note that admonitions themselves can contain other block-level elements,
86+
such as code blocks, e.g.
8687

8788
```julia
8889
f(x) = x^2
8990
```
9091

91-
However, you **can not** have at-blocks, docstrings, doctests etc. in an admonition.
92+
and headings, e.g.
9293

93-
Headings are OK though:
9494
# Heading 1
9595
## Heading 2
9696
### Heading 3
9797
#### Heading 4
9898
##### Heading 5
9999
###### Heading 6
100100

101+
However, you **can not** have at-blocks, docstrings, doctests, etc. in an admonition.
102+
103+
An admonition is closed when the indentation stops,
104+
so blank lines may be used within or before the content to improve raw text readability.
105+
101106
###### Info admonition
102107
!!! info "'info' admonition"
103108
This is a `!!! info`-type admonition. This is the same as a `!!! note`-type.

0 commit comments

Comments
 (0)