Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
34 changes: 34 additions & 0 deletions docs/authoring/markdown-basics.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 3 additions & 1 deletion docs/prerelease/1.11/_highlights.qmd
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
Quarto v1.11 was just released, nothing to see here -- yet!
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.
Loading