Skip to content

docs: document page-level opt-out of social metadata - #2297

Merged
cderv merged 1 commit into
prereleasefrom
docs/page-social-metadata-opt-out
Oct 16, 2026
Merged

cderv merged 1 commit into
prereleasefrom
docs/page-social-metadata-opt-out

Conversation

@cderv

@cderv cderv commented Oct 16, 2026

Copy link
Copy Markdown
Member

Companion to quarto-dev/quarto-cli#15091. From Quarto 1.11, open-graph: false or twitter-card: false in a page or a _metadata.yml omits that metadata when the website enables it. Before, the page false was ignored and the site settings won.

The social metadata docs only described merging page and site metadata, so this adds a "Disabling on a Page" section to website-tools.qmd with the 1.11 prerelease callout. It targets prerelease because the behavior is only true from 1.11.

From Quarto 1.11 (quarto-dev/quarto-cli#15091), `open-graph: false` or
`twitter-card: false` in a page or a `_metadata.yml` omits that metadata
when the website enables it. The page only described merging page and
site metadata, so the opt-out was not discoverable.
@github-actions

Copy link
Copy Markdown
Contributor

📝 Preview Deployment

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

🔄 Modified Documents

cderv added a commit to quarto-dev/quarto-cli that referenced this pull request Oct 16, 2026
…of social metadata (#15091)

Pages read `bread-crumbs`, `back-to-top-navigation`, `page-navigation`,
`margin-header` and `margin-footer` from their own front matter, but the
document schema only declared them under `website:`, so a wrong-typed
page value passed validation silently and editors offered no completion.
A page `open-graph: false` or `twitter-card: false` also still emitted
`og:` or `twitter:` tags when the site enabled them. The provider loop
skipped a provider only when both page and site values were falsy, and
the merge treats a page `false` like an unset value, so the site won.

- Declare the five page-level options in the document schema, with the
  same types as their `website:` counterparts
- Skip a social metadata provider when the page sets it to `false`; an
  empty page value still falls back to the site setting

Related to #15084
See quarto-dev/quarto-web#2297 for the page opt-out documentation
@cderv
cderv merged commit a1a89d5 into prerelease Oct 16, 2026
4 checks passed
@cderv
cderv deleted the docs/page-social-metadata-opt-out branch October 16, 2026 18:40
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