Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@crypblizz/docusaurus-plugin-copy-page-button) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Docusaurus Copy Page Button Plugin

Extract Docusaurus documentation content as markdown for AI tools like ChatGPT and Claude

A lightweight Docusaurus plugin that automatically adds a "Copy page" button to your documentation site's sidebar. Perfect for developers who want to quickly extract documentation content for AI assistance, code reviews, or content analysis.

Why Use This Plugin?

AI-Ready Content: Instantly convert documentation pages to clean markdown for ChatGPT, Claude, or other AI tools
Developer Productivity: Copy entire documentation pages without manual selection and cleanup
Zero Configuration: Works out of the box - just install and go
Documentation Workflow: Streamline the process of getting documentation context for AI assistance

Features

📋 Copy page as markdown - Clean page content extraction
👁️ View as markdown - Preview extracted content in new tab
🤖 AI integration - Direct "Open in ChatGPT" and "Open in Claude" buttons
⚡ Auto-injection - Automatically adds to table of contents sidebar (no configuration needed)
🎨 Theme-aware - Supports light/dark themes
🎨 Customizable styling - Easy custom CSS classes and inline styles
📱 Mobile-friendly - Responsive design
🛠️ Zero-config - Works out of the box with sensible defaults

Installation

npm install docusaurus-plugin-copy-page-button

Usage

Option 1: Auto-injection (Recommended)

Add the plugin to your docusaurus.config.js:

module.exports = {
  plugins: ["docusaurus-plugin-copy-page-button"],
};

The button will automatically appear in your table of contents sidebar!

Option 2: Custom positioning

Use custom styles to position the button differently:

module.exports = {
  plugins: [
    [
      "docusaurus-plugin-copy-page-button",
      {
        customStyles: {
          button: {
            style: {
              position: "fixed",
              top: "20px",
              right: "20px",
            },
          },
        },
      },
    ],
  ],
};

Configuration

Custom Styling

You can customize the appearance of the copy page button by passing a customStyles option:

module.exports = {
  plugins: [
    [
      "docusaurus-plugin-copy-page-button",
      {
        customStyles: {
          button: {
            className: "my-custom-button",
            style: {
              backgroundColor: "#4CAF50",
              color: "white",
              borderRadius: "8px",
            },
          },
          dropdown: {
            className: "my-custom-dropdown",
            style: {
              backgroundColor: "#f8f9fa",
              border: "2px solid #4CAF50",
            },
          },
          dropdownItem: {
            style: {
              padding: "12px 20px",
              fontSize: "16px",
            },
          },
          container: {
            className: "my-button-container",
          },
        },
      },
    ],
  ],
};

Available Style Targets

button - The main copy page button (positioning styles like position, top, left are automatically applied to the container)
dropdown - The dropdown menu that appears when clicking the button
dropdownItem - Individual items in the dropdown menu
container - The wrapper container around the button

Style Options

Each target accepts:

className - CSS class name(s) to add to the element
style - Inline styles object (React style format)

Custom styles are merged with the default styles, so you only need to specify what you want to change.

Example: Custom positioning

module.exports = {
  plugins: [
    [
      "docusaurus-plugin-copy-page-button",
      {
        customStyles: {
          button: {
            style: {
              position: "fixed",
              top: "100px",
              left: "100px",
              zIndex: 1000,
            },
          },
        },
      },
    ],
  ],
};

Note: Positioning styles (position, top, right, bottom, left, zIndex, transform) specified in the button configuration are automatically applied to the container element for proper positioning control.

Example: Styling without positioning

module.exports = {
  plugins: [
    [
      "docusaurus-plugin-copy-page-button",
      {
        customStyles: {
          button: {
            style: {
              backgroundColor: "transparent",
              border: "2px solid #007acc",
              color: "#007acc",
              borderRadius: "12px",
              fontWeight: "bold",
            },
          },
        },
      },
    ],
  ],
};

You can add your own actions to the dropdown using customItems.

Supported action types:

copyMarkdown – copy extracted markdown to clipboard
viewMarkdown – open extracted markdown in a new tab
openUrl – open a URL built from a template; supports placeholders {url} and {title}
copyText – copy arbitrary text, or use a template via textTemplate with {url} and {title}

Example configuration with a “Copy MCP server” item that copies a URL to clipboard:

module.exports = {
  plugins: [
    [
      "docusaurus-plugin-copy-page-button",
      {
        customItems: [
          {
            id: "copy-mcp-server",
            title: "Copy MCP server",
            description: "Copy server URL to clipboard",
            emoji: "🔌",
            action: { type: "copyText", text: "https://www.wikipedia.org/" },
          },
        ],
      },
    ],
  ],
};

You may also use a raw SVG string instead of emoji by providing svg: "<svg ...>...</svg>".

Local Development

To test this plugin locally during development:

1. Clone and setup

git clone https://github.com/portdeveloper/docusaurus-plugin-copy-page-button.git
cd docusaurus-plugin-copy-page-button
npm install

2. Link the package

npm link

3. Use in your Docusaurus project

Navigate to your Docusaurus project and link the local plugin:

cd /path/to/your/docusaurus/project
npm link docusaurus-plugin-copy-page-button

4. Configure in docusaurus.config.js

Add the plugin to your config:

module.exports = {
  plugins: ["docusaurus-plugin-copy-page-button"],
};

5. Start development server

npm start

The locally linked plugin will now be active in your Docusaurus site. Any changes you make to the plugin source will require restarting the Docusaurus development server.

How It Works

The plugin intelligently extracts page content by:

Smart Content Selection: Automatically identifies the main documentation content area
Clean Extraction: Removes navigation, sidebars, headers, footers, and UI elements
Markdown Conversion: Converts HTML to properly formatted markdown with preserved structure
AI-Optimized Format: Includes page title, URL, and clean content perfect for AI tool input

Use Cases

AI-Assisted Development: Quickly share documentation context with ChatGPT or Claude for coding help
Code Reviews: Extract relevant documentation for code review discussions
Content Analysis: Analyze documentation structure and content for improvements
Knowledge Sharing: Easily share specific documentation sections with team members
Documentation Migration: Extract content for migrating to other documentation platforms

SEO Keywords

Docusaurus plugin, copy page button, extract documentation, markdown conversion, AI tools integration, ChatGPT documentation, Claude AI, content extraction, developer tools, documentation productivity, React plugin, JavaScript documentation tools.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

@crypblizz/docusaurus-plugin-copy-page-button