Skip to content

signalwire/docusaurus-plugins

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

84 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

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 npm 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


Package Details

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 β†’

About

Repo of SignalWIre developed Docusaurus plugins

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •