Skip to content

Releases: signalwire/docusaurus-plugins

Release 1.2.2

23 Jul 17:49

Choose a tag to compare

@signalwire/docusaurus-plugin-llms-txt@v1.2.1

29 Jun 11:28

Choose a tag to compare

What's Changed

Caching Enhancements:

  • Implement smarter caching strategy with better invalidation logic
  • Add new cache-filter.ts module for unified filtering in build and CLI contexts
  • Improve cache I/O operations with better error handling
  • Enhanced cache validation mechanisms
  • Add logger parameter to CacheManager for better debugging
  • Optimize processing coordinator for better performance with cached routes

Performance Improvements:

  • Add concurrent route processing using p-map for faster generation
  • Create route lookup table for improved link resolution performance
  • Simplify route matcher logic (removed redundant code)

Bug Fixes:

  • Fix route matcher logic that was causing excessive filtering
  • Fix HTML parsing edge cases in transformation pipeline
  • Fix link transformation to respect all content exclusion filters
  • Fix route validator to properly handle versioned docs and generated indexes
  • Add missing minimatch dependency

Route Processing Enhancements:

  • Significant improvements to route rule configuration handling
  • Better glob pattern support and validation with custom validators
  • Enhanced route processor with concurrent processing capabilities
  • Add route lookup functionality for better cross-referencing

Error Messages:

  • Improve user-facing error messages with troubleshooting steps
  • Better error reporting for invalid glob patterns
  • More helpful messages for common CLI issues

Code Quality:

  • Multiple code formatting improvements across all modules
  • Fix all linting errors
  • Consistent code style throughout the codebase

Internal Changes:

  • Simplify content classifier logic
  • Refactor route processing for better maintainability
  • Add ContentType union type for better type safety
  • Enhanced logging in cache filtering operations
  • Move route matching logic to appropriate modules for better organization

Full Changelog: https://github.com/signalwire/docusaurus-plugins/compare/@signalwire/docusaurus-plugin-llms-txt@v1.2.0...@signalwire/docusaurus-plugin-llms-txt@v1.2.1

@signalwire/docusaurus-plugin-llms-txt@v1.2.0

25 Jun 01:29
1bba85a

Choose a tag to compare

What's Changed

🎉 New Features

Versioned Documentation Support

  • Enhanced versioned docs detection: The plugin now properly
    identifies and processes all versions of Docusaurus
    documentation (v1, v2, v3, etc.)
  • New includeVersionedDocs option: Control whether to include
    versioned documentation or only the current version
  • Improved plugin information mapping: Better handling of
    Docusaurus route flattening to preserve version metadata

Generated Index Page Control

  • New includeGeneratedIndex option: Choose whether to include
    Docusaurus auto-generated category index pages
  • Better content filtering: Exclude navigation-only pages when
    you only want actual content pages

🔧 Route Rules Enhancements

Advanced Glob Pattern Support

  • Comprehensive glob patterns: Full support for **, *, [], {},
    and negation patterns
  • Versioned API targeting: New patterns specifically for
    versioned documentation:
    • /api/v[0-9]*/** - Target only numbered versions (excludes
      paths like /api/video)
    • /api/{v1,v2,v3}/** - Target specific versions only
    • /api/!(v*)/** - Exclude versioned paths entirely

Improved Route Matching

  • Better specificity handling: More intelligent route rule
    priority resolution
  • Enhanced pattern validation: Better error messages for
    invalid glob patterns
  • Performance optimizations: Faster route matching for large
    documentation sites

🚀 Performance & Reliability

Improved Caching Strategy

  • Smarter cache invalidation: Cache now invalidates based on
    significant route count changes
  • Better route classification: More accurate detection of
    document types and versions
  • Optimized processing: Reduced unnecessary processing for
    unchanged content

Enhanced Error Handling

  • Better route processing: More resilient handling of
    problematic routes
  • Improved logging: Better debug information at higher log
    levels
  • Graceful degradation: Better fallback behavior when
    individual pages fail

📚 Documentation

Comprehensive Route Rules Guide

  • New versioned documentation patterns section: Detailed
    examples for targeting specific API versions
  • Glob pattern reference: Complete guide to using glob patterns
    in route rules
  • Real-world examples: Practical examples for common
    documentation structures
  • Pattern specificity guide: Clear explanations of how
    different patterns match routes

Enhanced Configuration Examples

  • API documentation focus: Examples tailored for API
    documentation sites
  • Multi-version setups: Configuration examples for sites with
    multiple API versions
  • Performance optimization: Examples for large documentation
    sites

🐛 Bug Fixes

Route Processing

  • Fixed versioned docs detection: Resolved issue where only
    current version was being processed
  • Improved route matching: Fixed cases where glob patterns
    weren't matching expected paths
  • Better depth rule application: Fixed issues with depth
    settings not being applied correctly

Full Changelog: https://github.com/signalwire/docusaurus-plugins/compare/@signalwire/docusaurus-plugin-llms-txt@1.1.0...@signalwire/docusaurus-plugin-llms-txt@v1.2.0

Release @signalwire/docusaurus-plugin-llms-txt@v1.1.0

16 Jun 11:59

Choose a tag to compare

Full Changelog: https://github.com/signalwire/docusaurus-plugins/compare/@signalwire/docusaurus-plugin-llms-txt@1.1.0...@signalwire/docusaurus-plugin-llms-txt@1.1.0

1.1.0

Minor Changes

  • #6: Add support for generating llms-full.txt with complete markdown content & fix routing issues.

    • Added new enableLlmsFullTxt configuration option (defaults to false)
    • When enabled, generates an additional llms-full.txt file that starts with the complete
      llms.txt content, followed by the full processed markdown content of each document
    • The llms-full.txt follows the llms.txt standard format with the index at the top and full
      content appended below
    • Updated CLI clean command to also remove llms-full.txt file when cleaning
    • Support in-memory content processing when enableMarkdownFiles: false but
      enableLlmsFullTxt: true
    • Hash-based change detection now works regardless of markdown file settings
    • Fix path resolution issue for baseUrl configurations
    • Fix path resolution issues for configs with trailingSlash set to false

Fixes GitHub issue #5 where users saw "ENOENT: no such file or directory" errors with certain Docusaurus baseUrl configuration.

@signalwire/docusaurus-plugin-llms-txt@1.0.1

05 Jun 15:35
d459c86

Choose a tag to compare

docusaurus-plugin-llms-txt

A powerful Docusaurus plugin that generates Markdown versions of your HTML pages and creates an llms.txt index file for AI/LLM consumption. Perfect for making your documentation easily accessible to Large Language Models while maintaining human-readable markdown files.

Features

  • 🔄 HTML to Markdown Conversion: Automatically converts your Docusaurus HTML pages to clean markdown files
  • 📝 llms.txt Generation: Creates a comprehensive index file with links to all your documentation
  • 🗂️ Hierarchical Organization: Intelligently organizes documents into categories with configurable depth
  • Smart Caching: Efficient caching system for fast incremental builds
  • 🎯 Content Filtering: Flexible filtering by content type (docs, blog, pages) and custom patterns
  • 🔧 Route Rules: Advanced configuration for specific routes with custom processing
  • 💻 CLI Commands: Standalone CLI for generation and cleanup operations
  • 🎨 Customizable Content Extraction: Configurable CSS selectors for precise content extraction
  • 📊 Table Processing: Intelligent table handling with rehype processing
  • 🔗 Link Management: Smart internal link processing with relative/absolute path options

Installation

npm install @signalwire/docusaurus-plugin-llms-txt

Quick Start

Basic Setup

Add the plugin to your docusaurus.config.js:

module.exports = {
  plugins: [
    'docusaurus-plugin-llms-txt'
  ]
};

Basic Configuration

module.exports = {
  plugins: [
    [
      'docusaurus-plugin-llms-txt',
      {
        siteTitle: 'My Documentation',
        siteDescription: 'Comprehensive guide to our platform',
        depth: 2,
        content: {
          includeBlog: true,
          includePages: true
        }
      }
    ]
  ]
};

After building your site (npm run build), you'll find:

  • llms.txt in your build output directory
  • Individual markdown files for each page (if enabled)

What's Changed

New Contributors

Full Changelog: https://github.com/signalwire/docusaurus-plugins/commits/@signalwire/docusaurus-plugin-llms-txt@1.0.1