Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document blank lines allowed in admonitions #2515

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+9 −4
Open

Document blank lines allowed in admonitions #2515

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions docs/src/showcase.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,25 +79,30 @@ Documenter supports a range of admonition types for different circumstances.

###### Note admonition
!!! note "'note' admonition"

Admonitions look like this. This is a `!!! note`-type admonition.

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

```julia
f(x) = x^2
```

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

Headings are OK though:
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

However, you **can not** have at-blocks, docstrings, doctests, etc. in an admonition.

An admonition is closed when the indentation stops,
so blank lines may be used within or before the content to improve raw text readability.

###### Info admonition
!!! info "'info' admonition"
This is a `!!! info`-type admonition. This is the same as a `!!! note`-type.
Expand Down
Loading