Skip to content

docs(typst): document code annotations and the filename bar - #2308

Open
mcanouil wants to merge 5 commits into
quarto-dev:prereleasefrom
mcanouil:docs/typst-code-annotations-14170-prerelease
Open

mcanouil wants to merge 5 commits into
quarto-dev:prereleasefrom
mcanouil:docs/typst-code-annotations-14170-prerelease

Conversation

@mcanouil

@mcanouil mcanouil commented Oct 27, 2026 •

Copy link
Copy Markdown
Collaborator

Documents code annotations and the filename attribute for Typst output, added in:

The code annotation page gets a Typst tab with a screenshot and a prerelease callout for 1.12.
It also says that hover and select use the same layout as below in Typst, and that the Typst format supports annotations.
The HTML code page now says that Typst shows the filename in a bar above the code block, and its _freeze entry is refreshed for that sentence.
The markdown basics page says the same next to the filename example.

The Typst custom format page gets a "Code Blocks" section for format and filter authors.
It describes quarto-code-filename, which draws a code block with a filename, and the quarto-code-block-style state, which holds the inset, radius and outline of code blocks.
Its example draws a frame around a code block with a filename, and I rendered that example with a Quarto build of quarto-dev/quarto-cli#14170.

The pull request targets prerelease, because the feature is new in 1.12.
I rendered the changed pages on their own with quarto render, not the whole site, and the new text, callouts and screenshot appear in the output.

The screenshot is from a Typst render of the existing penguins example.

@mcanouil
mcanouil marked this pull request as ready for review November 1, 2026 20:53
The Typst custom format page now describes quarto-code-filename and quarto-code-block-style, with an example frame. The code annotation callout names 1.12, the release that brings the feature.

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