Skip to content

docs: explain that a format-links object renames that format's link - #2344

Merged
cderv merged 1 commit into
prereleasefrom
docs-format-links-9606
Nov 6, 2026
Merged

cderv merged 1 commit into
prereleasefrom
docs-format-links-9606

Conversation

@cderv

@cderv cderv commented Nov 6, 2026

Copy link
Copy Markdown
Member

From Quarto 1.12, a format-links entry written as an object (format, text, icon) renames the link for that format, and other rendered formats keep their default links. Before, the default link was added as well, so a renamed typst link showed up twice, as "PDF" and "Typst", unless the list also had a plain-string entry. The example in "Specifying Formats to Link" listed - html, which avoided the duplicate.

Remove - html from that example and explain how the two kinds of entry combine: an object renames a link, and plain strings limit the links to the formats they name.

Targets prerelease because the fix ships in 1.12.

Companion to quarto-dev/quarto-cli#15312

From Quarto 1.12, a `{format, text}` entry in `format-links` replaces
the default link for that format, and other rendered formats keep
their default links. Before, the default link was added as well, so a
renamed format appeared twice ("PDF" and "Typst"). The only way around
it was to add a plain-string entry, which is why the example listed
`- html`.

Drop that line from the example, and explain how object entries and
plain-string entries interact.
@github-actions

github-actions Bot commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

📝 Preview Deployment

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

🔄 Modified Documents

@cderv
cderv merged commit 3aca831 into prerelease Nov 6, 2026
4 checks passed
@cderv
cderv deleted the docs-format-links-9606 branch November 6, 2026 17:05
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