From 6a2c42ab02d3db57fdf77f566707f8cb09c6718a Mon Sep 17 00:00:00 2001 From: Felipe Cotti Date: Thu, 4 Jun 2026 20:15:34 -0300 Subject: [PATCH 1/3] 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 --- docs/syntax/admonitions.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/syntax/admonitions.md b/docs/syntax/admonitions.md index 6498193312..8912035337 100644 --- a/docs/syntax/admonitions.md +++ b/docs/syntax/admonitions.md @@ -4,7 +4,8 @@ Admonitions allow you to highlight important information with varying levels of ## Basic admonitions -Admonitions can span multiple lines and support inline formatting. +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. + Available admonition types include: - [Note](#note) @@ -135,6 +136,8 @@ A plain admonition is a callout with no further styling. Useful to create a call ::::{tab-item} Output :::{admonition} This is my callout +This is a plain callout. + It can *span* multiple lines and supports inline formatting. ::: @@ -144,6 +147,8 @@ It can *span* multiple lines and supports inline formatting. ```markdown :::{admonition} This is my callout +This is a plain callout. + It can *span* multiple lines and supports inline formatting. ::: ``` From 3c11ef33336c5ffdeb879fd83ecd2a3133e00160 Mon Sep 17 00:00:00 2001 From: Felipe Cotti Date: Fri, 5 Jun 2026 16:22:58 -0300 Subject: [PATCH 2/3] Update docs/syntax/admonitions.md Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com> --- docs/syntax/admonitions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/syntax/admonitions.md b/docs/syntax/admonitions.md index 8912035337..e032291037 100644 --- a/docs/syntax/admonitions.md +++ b/docs/syntax/admonitions.md @@ -4,7 +4,7 @@ Admonitions allow you to highlight important information with varying levels of ## Basic admonitions -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. +Admonitions can span multiple lines and support inline formatting. Available admonition types include: From 4e823741094f904e74bc002339a576f94cfc3832 Mon Sep 17 00:00:00 2001 From: Felipe Cotti Date: Tue, 16 Jun 2026 07:40:44 -0300 Subject: [PATCH 3/3] 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 --- docs/syntax/admonitions.md | 28 +++++++++++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/docs/syntax/admonitions.md b/docs/syntax/admonitions.md index e032291037..138e9d8767 100644 --- a/docs/syntax/admonitions.md +++ b/docs/syntax/admonitions.md @@ -4,7 +4,33 @@ Admonitions allow you to highlight important information with varying levels of ## Basic admonitions -Admonitions can span multiple lines and support inline formatting. +Admonitions can span multiple lines and support inline formatting. + +:::::{tab-set} + +::::{tab-item} Output + +:::{admonition} Multiple paragraphs +Separate paragraphs with a blank line, just like regular Markdown. + +Adjacent lines without a blank line between them render as a single paragraph. +::: + +:::: + +::::{tab-item} Markdown + +```markdown +:::{admonition} Multiple paragraphs +Separate paragraphs with a blank line, just like regular Markdown. + +Adjacent lines without a blank line between them render as a single paragraph. +::: +``` + +:::: + +::::: Available admonition types include: