Skip to content
starlight-llm-actions

Per-page opt-out

Some pages don’t benefit from the dropdown — marketing pages, landing pages, auto-generated indexes, or pages with policy reasons not to expose raw markdown. The plugin supports a frontmatter opt-out to hide the dropdown on those pages without touching the global config.

Use it

Section titled “Use it”

Add the opt-out key to the page’s frontmatter:

src/content/docs/marketing/landing.mdx
---
title: Marketing landing page
llmActions: false
---


Your content here…

The dropdown won’t render on that page. The rest of the site keeps the dropdown as configured.

Live example

Section titled “Live example”

The Opt-out example page on this site sets llmActions: false in its frontmatter. Compare its header to any other page on this site — you’ll see the dropdown is gone.

Customising the frontmatter key

Section titled “Customising the frontmatter key”

The default key is llmActions. Change it via the pageOptOut option:

starlightLlmActions({
  pageOptOut: 'showAiTools',
})

Pages then use:

---
title: ...
showAiTools: false
---

Disabling opt-out entirely

Section titled “Disabling opt-out entirely”

If you want the dropdown to render on every page no matter what:

starlightLlmActions({
  pageOptOut: false,
})

Frontmatter values for the opt-out key are ignored.

When to use it

Section titled “When to use it”
  • Marketing or landing pages that don’t have a meaningful markdown body.
  • Pages with sensitive content where exposing raw markdown is a policy concern. (Note: llmActions: false hides the dropdown and the print/PDF snapshot notice on this page, but the markdown route at /{slug}.md is still injected. To suppress the route too, see injectRoute.)
  • Auto-generated index pages where every action would feel out of place.

When not to use it

Section titled “When not to use it”

llmActions: false is a blunt instrument — it hides the entire dropdown. For finer-grained per-page changes, use a partial override instead of false:

See the Examples section for a page-by-page walkthrough of every override.