Configure Page Actions

Starlight Page Actions allows you to customize which actions appear on your documentation pages, including built-in integrations with AI tools and custom actions.

Default actions

By default, the plugin displays three actions: “Open in ChatGPT”, “Open in Claude”, and “View in Markdown”.

The plugin includes five built-in actions that you can enable or disable using the actions property:

• chatgpt - Opens the current page in ChatGPT
• claude - Opens the current page in Claude
• t3chat - Opens the current page in T3 Chat (disabled by default)
• v0 - Opens the current page in v0 (disabled by default)
• cursor - Opens the current page in Cursor (disabled by default)
• perplexity - Opens the current page in Perplexity (disabled by default)
• githubCopilot - Opens the current page in GitHub Copilot (disabled by default)
• markdown - View the page content in Markdown format

You can enable or disable any of these actions by setting them to true or false:

starlightPageActions({
  actions: {
    chatgpt: false, // Disable ChatGPT action
    claude: true, // Enable Claude action
    t3chat: true, // Enable T3 Chat action
    v0: true, // Enable v0 action
    markdown: false, // Disable Markdown action
  },
});

Note

All default actions are internationalized and support English, Spanish, Portuguese, French, Italian, and German. The “Copy Markdown” button is also included in the internationalization.

Custom actions

You can add your own custom actions to integrate with additional tools or services. Custom actions are defined using the custom property with a unique key for each action.

starlightPageActions({
  actions: {
    custom: {
      sciraAi: {
        label: "Open in Scira AI",
        href: "https://scira.ai/?q=",
      },
    },
  },
});

Tip

The href should include the complete URL with the appropriate query parameter structure for the service you’re integrating. Make sure to include the query parameter name (e.g., ?q=, ?query=, ?prompt=) at the end.

Combining default and custom actions

You can mix default actions with custom actions. Custom actions will appear after the default actions:

starlightPageActions({
  actions: {
    chatgpt: false,
    v0: true,
    custom: {
      sciraAi: {
        label: "Open in Scira AI",
        href: "https://scira.ai/?q=",
      },
    },
  },
});

Note

If all default actions are set to false and no custom actions are specified, the page actions section will not be displayed.

Internationalization

Custom actions can be internationalized. See the Internationalization guide for more details.

import { defineConfig } from "astro/config";
import starlight from "@astrojs/starlight";
import starlightPageActions from "starlight-page-actions";

export default defineConfig({
  integrations: [
    starlight({
      locales: {
        root: {
          label: "English",
          lang: "en",
        },
        es: {
          label: "Español",
          lang: "es",
        },
      },
      plugins: [
        starlightPageActions({
          actions: {
            chatgpt: false,
            v0: true,
            custom: {
              sciraAi: {
                label: "Open in Scira AI",
                href: "https://scira.ai/?q=",
              },
            },
          },
          locales: {
            es: {
              prompt: "Lee {url} y explica brevemente sus puntos principales.",
              actions: {
                custom: {
                  sciraAi: {
                    label: "Abrir en Scira AI",
                    href: "https://scira.ai/?q=",
                  },
                },
              },
            },
          },
        }),
      ],
      title: "My Docs",
    }),
  ],
});