Page ActionsCopy Anchor Link

Page actions are buttons rendered above or below the page title. They let users interact with page content — copy it as Markdown, or open it in an LLM provider like ChatGPT or Claude.

Quick StartCopy Anchor Link

pageActions: {
  copyMarkdown: { enabled: true },
  openDocs: { enabled: true },
  connectMcp: true,
  installSkills: true,
}

This adds the content actions plus Connect MCP and Install skills setup controls.

Configuration ReferenceCopy Anchor Link

All options go inside the pageActions object in docs.config.ts:

export default defineDocs({
  pageActions: {
    // ... options
  },
});

pageActions.positionCopy Anchor Link

Where to render the page action buttons relative to the page title.

pageActions: {
  position: "above-title",
}

pageActions.alignmentCopy Anchor Link

Control whether the action row is left- or right-aligned.

pageActions: {
  alignment: "right",
}

Agent setup actionsCopy Anchor Link

pageActions.connectMcpCopy Anchor Link

Show one-click, copyable MCP setup for the raw endpoint, Claude Code, Cursor, VS Code, and Codex. Relative endpoints are resolved against the deployed docs origin.

pageActions: {
  connectMcp: {
    enabled: true,
    endpoint: "/mcp",
    providers: ["copy", "claude-code", "cursor", "vscode", "codex"],
    label: "Connect docs MCP",
  },
}

pageActions.installSkillsCopy Anchor Link

Read the published /.well-known/agent-skills/index.json catalog and offer a copyable Skills CLI command. You can override the index or command when the docs are hosted behind a proxy.

pageActions: {
  installSkills: {
    enabled: true,
    index: "/.well-known/agent-skills/index.json",
    command: "npx skills add https://docs.example.com",
  },
}

Both actions are opt-in. Keep mcp and agent.skills enabled so the copied setup resolves to live surfaces after deployment.

Copy MarkdownCopy Anchor Link

pageActions.copyMarkdownCopy Anchor Link

Whether to show the "Copy Markdown" button. Copies the current page's content as Markdown to the clipboard.

pageActions: {
  copyMarkdown: true,
  // or
  copyMarkdown: { enabled: true },
}

The object form also lets you customize the button text.

pageActions.copyMarkdown.labelCopy Anchor Link

Button label shown before the page has been copied.

pageActions.copyMarkdown.copiedLabelCopy Anchor Link

Button label shown after a successful copy.

pageActions.copyMarkdown.formatCopy Anchor Link

Content format that the button copies to the clipboard.

• "markdown" — fetches the page's public .md route and copies its markdown source.
• "text" — reads the visible text content of the rendered page without a network request.

pageActions: {
  copyMarkdown: { enabled: true, format: "text" },
}

pageActions: {
  copyMarkdown: { enabled: true, label: "Copy docs", copiedLabel: "Copied docs" },
}

pageActions.copyMarkdown.includeTitleCopy Anchor Link

Whether to prepend the current page title to the copied content.

When enabled:

• In "markdown" format a # Title heading is added before the page content.
• In "text" format the plain title is prepended as a first line.

The title is not added if the content already begins with it.

pageActions: {
  copyMarkdown: { enabled: true, includeTitle: true },
}

Open in LLMCopy Anchor Link

The Open in... dropdown lets users send the current page to an LLM or tool. Built-in providers can target the public .md route, the rendered page, the source .mdx URL, or the GitHub edit URL.

pageActions.openDocsCopy Anchor Link

Enable the "Open in..." dropdown. Can be a boolean or an object with additional configuration.

pageActions: {
  openDocs: true,
}

When set to true, the built-in provider list is used: ChatGPT and Claude.

pageActions.openDocs.enabledCopy Anchor Link

Whether to show the "Open in..." dropdown.

pageActions.openDocs.providersCopy Anchor Link

Custom list of LLM / tool providers to show in the dropdown. Use provider strings for the built-in presets, or objects when you need icons, labels, per-provider prompts, or a custom URL template.

pageActions: {
  openDocs: {
    enabled: true,
    target: "markdown",
    providers: ["chatgpt", "claude", "cursor"],
  },
}

Built-in provider ids are "chatgpt", "claude", "cursor", "gemini", "copilot", "perplexity", and "github".

Each of these built-in presets automatically renders a monochrome provider icon in the dropdown — no icon field is required. You only need to supply an icon when using a custom urlTemplate provider or when you want to override the default mark for a named preset.

pageActions.openDocs.targetCopy Anchor Link

Controls which URL is inserted into {url} for the built-in provider prompt.

pageActions.openDocs.promptCopy Anchor Link

Prompt text sent to built-in providers. It defaults to:

"Read this documentation: {url}"

You can make the handoff more specific:

pageActions: {
  openDocs: {
    enabled: true,
    target: "markdown",
    prompt: "Use this documentation while editing the codebase: {url}",
    providers: ["chatgpt", "claude", "perplexity", { id: "cursor", mode: "app" }],
  },
}

Provider ObjectsCopy Anchor Link

Provider objects can customize a preset while keeping its built-in URL:

import { SiClaude, SiOpenai } from "react-icons/si";

pageActions: {
  openDocs: {
    enabled: true,
    target: "markdown",
    providers: [
      { id: "chatgpt", name: "ChatGPT", icon: <SiOpenai className="size-4" /> },
      { id: "claude", name: "Claude", icon: <SiClaude className="size-4" /> },
      {
        id: "cursor",
        mode: "app",
        prompt: "Open this docs page in Cursor context: {url}",
      },
    ],
  },
}

Custom URL TemplatesCopy Anchor Link

Use urlTemplate when you need a provider that is not built in. This keeps the previous API working.

pageActions: {
  openDocs: {
    enabled: true,
    providers: [
      {
        name: "Internal AI",
        urlTemplate: "https://internal.example/new?prompt={prompt}",
        prompt: "Read this documentation: {markdownUrl}",
      },
    ],
  },
}

The urlTemplate string supports these placeholders:

Full ExampleCopy Anchor Link

export default defineDocs({
  pageActions: {
    position: "below-title",
    copyMarkdown: { enabled: true },
    openDocs: {
      enabled: true,
      target: "markdown",
      prompt: "Read this documentation: {url}",
      providers: ["chatgpt", "claude", "cursor"],
    },
  },
});