Skip to content

Commit 6a2c42a

Browse files
cotticursoragent
andcommitted
docs: show blank-line rule in admonition multi-line examples
Fix the Plain admonition example so it actually renders multiple lines, and spell out that paragraphs inside an admonition must be separated by a blank line. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 667e2ec commit 6a2c42a

1 file changed

Lines changed: 6 additions & 1 deletion

File tree

docs/syntax/admonitions.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ Admonitions allow you to highlight important information with varying levels of
44

55
## Basic admonitions
66

7-
Admonitions can span multiple lines and support inline formatting.
7+
Admonitions can span multiple lines and support inline formatting. To split the content into separate paragraphs, separate them with a blank line — adjacent lines collapse into a single paragraph.
8+
89
Available admonition types include:
910

1011
- [Note](#note)
@@ -135,6 +136,8 @@ A plain admonition is a callout with no further styling. Useful to create a call
135136
::::{tab-item} Output
136137

137138
:::{admonition} This is my callout
139+
This is a plain callout.
140+
138141
It can *span* multiple lines and supports inline formatting.
139142
:::
140143

@@ -144,6 +147,8 @@ It can *span* multiple lines and supports inline formatting.
144147

145148
```markdown
146149
:::{admonition} This is my callout
150+
This is a plain callout.
151+
147152
It can *span* multiple lines and supports inline formatting.
148153
:::
149154
```

0 commit comments

Comments
 (0)