Getting Started

starlight-copy-button adds an accessible, polished copy button next to each docs page title in Starlight.

Installation

1. Install starlight-copy-button from GitHub:

   pnpm

   pnpm add github:dionysuzx/starlight-copy-button

   npm

   npm install github:dionysuzx/starlight-copy-button

   bun

   bun add github:dionysuzx/starlight-copy-button

2. Add the plugin to your Starlight plugins config:

   astro.config.mjs

   import starlight from '@astrojs/starlight'
   import { defineConfig } from 'astro/config'
   import starlightCopyButton from 'starlight-copy-button'
   
   export default defineConfig({
     integrations: [
       starlight({
         title: 'My Docs',
         plugins: [starlightCopyButton()],
       }),
     ],
   })

3. Start your docs site in dev mode and open any docs page:

   pnpm

   pnpm dev

   npm

   npm run dev

   bun

   bun run dev

What gets added automatically

The plugin:

• Injects client behavior to copy full page Markdown to the clipboard.
• Adds starlight-copy-button/styles.css to your Starlight customCss.
• Skips pages that use Starlight’s hero title layout.