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

🚀 Quick Start

Installation

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

Usage

Add to your docusaurus.config.js:

module.exports = {
  plugins: [
    [
      '@signalwire/docusaurus-plugin-llms-txt',
      {
        // Plugin options
      },
    ],
  ],
};

🏗 Development

Prerequisites

• Node.js ≥ 18.0.0
• Yarn ≥ 1.22.0

Setup

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

# Install dependencies
yarn install

# Build all packages
yarn build:packages

Development Workflow

# Start development with watch mode
yarn dev

# Run tests
yarn test

# Lint code
yarn lint

# Type check
yarn type-check

# Format code
yarn format

Adding New Packages

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

📋 Scripts Reference

Command	Description
yarn dev	Start development server
yarn build	Build all packages and website
yarn build:packages	Build all packages only
yarn test	Run tests in all packages
yarn lint	Lint all packages
yarn format	Format all code
yarn clean	Clean build artifacts

📤 Publishing

This monorepo uses Changesets for version management and publishing.

Quick Publishing

# Create a changeset
yarn changeset

# Version packages and update changelogs
yarn changeset:version

# Publish to npm
yarn changeset:publish

For detailed publishing instructions, see PUBLISHING.md.

🏛 Architecture

Monorepo Structure

docusaurus-plugins/
├── packages/                    # Published packages
│   └── docusaurus-plugin-llms-txt/
├── website/                     # Demo/documentation site
├── .changeset/                  # Changeset configuration
├── lerna.json                   # Lerna configuration
└── package.json                 # Root package with workspaces

Technology Stack

• Package Management: Yarn Workspaces + Lerna
• Build System: TypeScript with project references
• Version Management: Changesets
• Code Quality: ESLint + Prettier + Husky
• 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 yarn prerelease to verify everything works
6. Create a changeset with yarn 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 →