From 259e263d659cb0b5106dbe59429e40797cf58026 Mon Sep 17 00:00:00 2001 From: Carlos Scheidegger Date: Wed, 21 Oct 2026 17:29:00 -0400 Subject: [PATCH] Document the `.definition-list` div syntax (1.11) Adds a Definition Lists section to Markdown Basics for the div syntax from quarto-dev/quarto-cli#15140, and a 1.11 highlight for it. Co-Authored-By: Claude Opus 5.5 --- docs/authoring/markdown-basics.qmd | 34 ++++++++++++++++++++++++++++ docs/prerelease/1.11/_highlights.qmd | 4 +++- 2 files changed, 37 insertions(+), 1 deletion(-) diff --git a/docs/authoring/markdown-basics.qmd b/docs/authoring/markdown-basics.qmd index 5358caee68..4ac18e5edc 100644 --- a/docs/authoring/markdown-basics.qmd +++ b/docs/authoring/markdown-basics.qmd @@ -271,6 +271,40 @@ Violets are blue. Note that unlike other Markdown renderers (notably Jupyter and GitHub), lists in Quarto require an entire blank line above the list. Otherwise the list will not be rendered in list form, rather it will all appear as normal text along a single line. +## Definition Lists + +{{< prerelease-callout 1.11 >}} + +Besides the `term` / `: definition` syntax shown above, you can write a definition list as a fenced div with the `.definition-list` class containing a bullet list. Each top-level bullet is a term, and the bullets nested under it are its definitions: + +``` markdown +::: {.definition-list} +* `time` + - A timestamp that identifies + when the request was initiated. + - Type: string +* `id` + - A unique identifier. +::: +``` + +This renders as: + +::: {.definition-list} +* `time` + - A timestamp that identifies + when the request was initiated. + - Type: string +* `id` + - A unique identifier. +::: + +A definition can hold several paragraphs, code blocks, or other lists, as long as they are indented under its bullet. Separate the bullets with blank lines when a definition has more than one paragraph. + +This is the definition list syntax of Quarto 2, which doesn't support the `: definition` syntax. Using it now lets your documents work in both versions. + +A `.definition-list` div must contain only the bullet list, and each term must have a nested bullet list of definitions. A div that doesn't follow this structure is rendered as an ordinary div. Any id, other classes, or attributes on the div are not kept on the definition list. + ## Footnotes Pandoc supports numbering and formatting footnotes using the following syntax: diff --git a/docs/prerelease/1.11/_highlights.qmd b/docs/prerelease/1.11/_highlights.qmd index 74f9b859e5..b0a8b7f9d0 100644 --- a/docs/prerelease/1.11/_highlights.qmd +++ b/docs/prerelease/1.11/_highlights.qmd @@ -1 +1,3 @@ -Quarto v1.11 was just released, nothing to see here -- yet! \ No newline at end of file +Quarto 1.11 includes the following new features: + +- [Definition list divs](/docs/authoring/markdown-basics.qmd#definition-lists): Write definition lists as a `.definition-list` div holding a nested bullet list, the definition list syntax of Quarto 2.