Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cderv merged 1 commit into from
Oct 16, 2026
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/websites/website-tools.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,24 @@ open-graph:

Pages in that directory that use the site image also get these sizes.

### Disabling on a Page

{{< prerelease-callout 1.11 >}}

When `twitter-card` or `open-graph` is enabled under `website:`, a page can omit that metadata by setting the option to `false` in its front matter:

```{.yaml filename="notes.qmd"}
---
title: "Notes"
open-graph: false
twitter-card: false
---
```

To omit it for every page in a directory, set the option to `false` in the directory's `_metadata.yml`. Each option is independent: a page with only `open-graph: false` still gets Twitter Card metadata.

Before Quarto 1.11, `false` in a page had no effect when the website enabled the metadata.

### Preview Images

You can specify a preview image for your article in several different ways:
Expand Down
Loading