Skip to content

Document the .definition-list div syntax (1.11) - #2305

Draft
cscheid wants to merge 1 commit into
prereleasefrom
feature/definition-list-div
Draft

cscheid wants to merge 1 commit into
prereleasefrom
feature/definition-list-div

Conversation

@cscheid

@cscheid cscheid commented Oct 21, 2026

Copy link
Copy Markdown
Member

Documentation for quarto-dev/quarto-cli#15140 (draft), which adds Quarto 2's .definition-list div syntax to Quarto 1.11.

  • docs/authoring/markdown-basics.qmd: new Definition Lists section after Lists, with a prerelease-callout 1.11, an example of the source followed by its output, and the structural rules: what a malformed div does, and that the div's attributes are dropped.
  • docs/prerelease/1.11/_highlights.qmd: replaces the placeholder with a highlight for the feature.

This targets prerelease because the feature is new in 1.11.

The live example only renders as a definition list once the prerelease build used for the site includes quarto-cli#15140. Until then it shows as nested bullets. I checked the page locally with a dev quarto pointed at the quarto-cli branch's filters: it renders a <dl> with both terms and the pre-release callout.

The existing term / : definition row in the Lists table is unchanged.

🤖 Generated with Claude Code

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 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

📝 Preview Deployment

🔍 Full site preview: https://deploy-preview-2305.quarto.org

🔄 Modified Documents

@cscheid

cscheid commented Oct 22, 2026

Copy link
Copy Markdown
Member Author

The main thing I'm not sure about here is the reference to Quarto 2. Should we include a link to the repo or just leave it as is? It might be the first official reference to "Quarto 2" in the docs.

cderv pushed a commit to quarto-dev/quarto-cli that referenced this pull request Oct 22, 2026
A `.definition-list` div holding one bullet list of terms, each followed
by a nested bullet list of definitions, now renders as a DefinitionList.
Quarto 2 uses this syntax in place of Pandoc's `term` / `: definition`
form, so authors can adopt it before upgrading to Quarto 2. Divs with
any other shape are left untouched, and the div's attributes are
dropped because DefinitionList has no Attr.

- Add a `definitionlist` module, registered in `_quarto.modules`
- Run it as an astpipeline pass right after the list-table pass, so it
  runs before crossrefs and user filters

See #13528 for the list-table precedent
See quarto-dev/quarto-web#2305 for the documentation

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant