Skip to content

v1.0.0 - Initial Release

Choose a tag to compare

@sionsmith sionsmith released this 06 Jan 06:34
· 5 commits to main since this release

Docusaurus LLM Docs Generator v1.0.0

📚 A GitHub Action to automatically generate LLM-optimized documentation from Docusaurus sites

Features

  • 📄 LLM-Ready Format: Generates llms.txt index for AI navigation
  • 📦 Markdown Archive: Creates markdown.zip with all docs as clean markdown
  • 🔗 Smart Link Transformation: Converts internal links to absolute URLs
  • 🧹 Clean Conversion: Strips HTML/JSX, preserves code blocks and formatting
  • 📋 Sidebar Aware: Reads your sidebars.js for proper hierarchy
  • 💡 Admonition Support: Converts Docusaurus admonitions to GitHub alerts
  • 🚀 Zero Config: Works out of the box with any Docusaurus site
  • ⚡ Fast: Processes 50+ pages in under 2 seconds

Quick Start

- uses: osodevops/docusaurus-llm-docs@v1
  with:
    base-url: 'https://docs.example.com'
    product-name: 'My Product'

See the README for full documentation.

What's Generated

  • llms.txt - Navigation index for LLMs with hierarchical structure
  • markdown.zip - Archive of all documentation as clean markdown files

Perfect for making your Docusaurus documentation accessible to AI assistants and LLMs!