Render Markdown definition lists#13950
Merged
Turbo87 merged 1 commit intoJun 15, 2026
Merged
Conversation
Enable comrak's `description_lists` extension so that Markdown definition lists in crate READMEs and descriptions render as `<dl>`/`<dt>`/`<dd>`, matching GitHub, GitLab and Forgejo. The `<dl>`/`<dt>`/`<dd>` tags are already permitted by the `ammonia` sanitizer, so no allowlist change is needed. Closes rust-lang#13890
Turbo87
approved these changes
Jun 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #13890.
Most forges (GitHub, GitLab, Forgejo) render Markdown definition lists:
crates.io previously ignored this syntax. This enables comrak's
description_listsextension so definition lists in crate READMEs and descriptions render as
<dl>/<dt>/<dd>:The
<dl>/<dt>/<dd>tags are already on theammoniasanitizer allowlist, sono sanitizer change is needed. Added a snapshot test covering the rendering.
cargo test -p crates_io_markdown,cargo clippy -p crates_io_markdown --all-targetsand
cargo fmtall pass.