Docusaurus Plugins Monorepo

A comprehensive collection of Docusaurus plugins built with TypeScript in a modern monorepo structure.

📦 Packages

Package	Version	Description
@signalwire/docusaurus-plugin-llms-txt		Generate Markdown versions of Docusaurus pages and an llms.txt index file
@signalwire/docusaurus-theme-llms-txt		Theme components for llms.txt plugin with copy-to-clipboard functionality

🚀 Quick Start

Installation

npm install @signalwire/docusaurus-plugin-llms-txt @signalwire/docusaurus-theme-llms-txt
# or
yarn add @signalwire/docusaurus-plugin-llms-txt @signalwire/docusaurus-theme-llms-txt

Usage

Add to your docusaurus.config.ts:

import type { Config } from '@docusaurus/types';

const config: Config = {
  plugins: [
    [
      '@signalwire/docusaurus-plugin-llms-txt',
      {
        // Plugin options
      },
    ],
  ],
  themes: ['@signalwire/docusaurus-theme-llms-txt'],
};

export default config;

🏗 Development

Prerequisites

• Node.js ≥ 20.0.0
• pnpm 10.x (corepack enable pnpm picks up the pinned version)

Setup

# Clone the repository
git clone https://github.com/signalwire/docusaurus-plugins.git
cd docusaurus-plugins

# Install dependencies and build all packages
pnpm run bootstrap

Development Workflow

# Start development with watch mode
pnpm dev

# Run tests
pnpm test

# Lint code
pnpm lint

# Type check
pnpm type-check

# Format code
pnpm format

Adding New Packages

1. Create a new directory in packages/
2. Add a package.json with standard scripts
3. pnpm will automatically detect and include it in all workspace operations

📋 Scripts Reference

Command	Description
pnpm dev	Start development server
pnpm build	Build all packages and website
pnpm build:packages	Build all packages only
pnpm run bootstrap	Install and build the workspace
pnpm test	Run tests in all packages
pnpm lint	Lint all packages
pnpm format	Format all code
pnpm clean	Clean build artifacts

📤 Publishing

This monorepo uses Changesets for version management and publishing.

Quick Publishing

# Create a changeset
pnpm changeset

# Version packages and update changelogs
pnpm changeset:version

# Publish to npm
pnpm changeset:publish

For detailed publishing instructions, see PUBLISHING.md.

🏛 Architecture

Monorepo Structure

docusaurus-plugins/
├── packages/                    # Published packages
│   ├── docusaurus-plugin-llms-txt/
│   └── docusaurus-theme-llms-txt/
├── website/                     # Demo/documentation site
├── .changeset/                  # Versioning and release (changesets)
├── pnpm-workspace.yaml          # Workspace packages and shared pnpm settings
└── package.json                 # Root scripts and development dependencies

Technology Stack

• Package Management: pnpm workspaces (linking and task running)
• Build System: TypeScript with project references
• Version Management: Changesets
• Code Quality: ESLint + Prettier
• Testing: Jest
• Documentation: Docusaurus

Key Features

• ✅ Independent Versioning: Each package can be versioned separately
• ✅ Automated Publishing: Changesets handle versioning and publishing
• ✅ Type Safety: Full TypeScript support with strict configuration
• ✅ Code Quality: Automated linting, formatting, and testing
• ✅ Auto-Discovery: New packages automatically included in all operations
• ✅ Modern ES Modules: Built for modern JavaScript environments

🤝 Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests if applicable
5. Run pnpm prerelease to verify everything works
6. Create a changeset with pnpm changeset
7. Submit a pull request

Development Guidelines

• Follow the existing code style (enforced by Prettier/ESLint)
• Add tests for new functionality
• Update documentation for API changes
• Use semantic commit messages
• Create changesets for all user-facing changes

📜 License

MIT © SignalWire

🔗 Links

• Documentation
• NPM Organization
• GitHub Issues
• Changesets Documentation
• Docusaurus Documentation

---

Package Details

@signalwire/docusaurus-plugin-llms-txt

Generate Markdown versions of Docusaurus HTML pages and create an llms.txt index file for LLM consumption.

Key Features:

• 🔄 HTML to Markdown conversion
• 📝 llms.txt index generation
• 🗂️ Hierarchical organization
• ⚡ Smart caching
• 🎯 Content filtering

View Package →

@signalwire/docusaurus-theme-llms-txt

Theme package providing UI components for the llms.txt plugin, including a copy-to-clipboard button for page content.

Key Features:

• 📋 Copy page content as Markdown
• 🤖 Format for ChatGPT and Claude
• 🎯 Smart detection of page title
• 📱 Responsive mobile/desktop layouts
• 🔧 Fully swizzlable components

Architecture:

• Uses DOM-based detection to identify page titles (H1 in <header> tags)
• Global data fetching with shared cache for performance
• Integrates seamlessly with Docusaurus theme system

View Package →