Skip to content

Commit bb33ae7

Browse files
cotticursoragentshainaraskas
authored
docs: clarify blank-line rule in admonition multi-line examples (#3468)
* 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> * Update docs/syntax/admonitions.md Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com> * docs: address review feedback on admonition examples - Add an explicit multi-paragraph admonition example (Output + Markdown tabs) so the page demonstrates the blank-line paragraph behavior instead of only asserting it. - Keep the intro sentence simple per review (no redundant prose rule); remove trailing whitespace introduced earlier. Co-authored-by: Cursor <cursoragent@cursor.com> --------- Co-authored-by: Cursor <cursoragent@cursor.com> Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
1 parent 5db19af commit bb33ae7

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

docs/syntax/admonitions.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,33 @@ Admonitions allow you to highlight important information with varying levels of
55
## Basic admonitions
66

77
Admonitions can span multiple lines and support inline formatting.
8+
9+
:::::{tab-set}
10+
11+
::::{tab-item} Output
12+
13+
:::{admonition} Multiple paragraphs
14+
Separate paragraphs with a blank line, just like regular Markdown.
15+
16+
Adjacent lines without a blank line between them render as a single paragraph.
17+
:::
18+
19+
::::
20+
21+
::::{tab-item} Markdown
22+
23+
```markdown
24+
:::{admonition} Multiple paragraphs
25+
Separate paragraphs with a blank line, just like regular Markdown.
26+
27+
Adjacent lines without a blank line between them render as a single paragraph.
28+
:::
29+
```
30+
31+
::::
32+
33+
:::::
34+
835
Available admonition types include:
936

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

137164
:::{admonition} This is my callout
165+
This is a plain callout.
166+
138167
It can *span* multiple lines and supports inline formatting.
139168
:::
140169

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

145174
```markdown
146175
:::{admonition} This is my callout
176+
This is a plain callout.
177+
147178
It can *span* multiple lines and supports inline formatting.
148179
:::
149180
```

0 commit comments

Comments
 (0)