Releases: osodevops/docusaurus-llm-docs
v1.2.2 - Fix sidebar hydration issue
Bug Fix
Fixed sidebar injection being overwritten by React hydration.
The Problem:
The previous approach injected HTML directly into the static sidebar, but when React hydrated the page on the client side, it replaced the DOM with its own state, removing our injected content.
The Solution:
Now we inject a small script that:
- Waits for React to finish hydrating
- Adds the LLM Resources section to the sidebar
- Uses MutationObserver to re-inject on SPA navigation
Full Changelog: v1.2.1...v1.2.2
v1.2.1 - Add llms-full.txt to sidebar
What's Changed
- Added
llms-full.txtlink to the automatically injected LLM Resources sidebar section - Users now see all three resources (llms.txt, llms-full.txt, markdown.zip) in the sidebar
Full Changelog: v1.2.0...v1.2.1
v1.2.0 - Complete Documentation File (llms-full.txt)
What's New
llms-full.txt - Complete Documentation in One File
Following the Cloudflare documentation format, the action now generates llms-full.txt - a single file containing your entire documentation with <page> delimiters.
Output files now include:
llms.txt- Lightweight navigation index with linksllms-full.txt- Complete documentation in a single file (NEW!)markdown.zip- Individual markdown files
llms-full.txt Format
# Your Product Documentation
> This file contains the complete documentation in a single file for LLM consumption.
<page>
---
title: Installation
description: How to install
source_url:
html: https://your-site.com/getting-started/installation
md: https://your-site.com/getting-started/installation.md
---
# Installation
This guide covers installing the SDK...
</page>New Output
| Output | Description |
|---|---|
llms-full-txt-path |
Path to generated llms-full.txt file |
Updated Workflow Example
- name: Copy LLM docs to build root
run: |
cp ${{ steps.llm-docs.outputs.llms-txt-path }} ./build/llms.txt
cp ${{ steps.llm-docs.outputs.llms-full-txt-path }} ./build/llms-full.txt
cp ${{ steps.llm-docs.outputs.markdown-zip-path }} ./build/markdown.zipFull Changelog
- Added
llms-full.txtgeneration with complete documentation - New output:
llms-full-txt-path - Updated README with llms-full.txt documentation and format examples
- Follows Cloudflare's
<page>delimiter format with YAML frontmatter
Full documentation: https://github.com/osodevops/docusaurus-llm-docs#readme
v1.1.0 - Automatic Sidebar Injection
What's New
Automatic Sidebar Injection
The action now automatically injects an "LLM Resources" section into your Docusaurus sidebar on every page. No manual sidebars.js configuration needed!
Before:
Getting Started
API Reference
Guides
Examples
After:
Getting Started
API Reference
Guides
Examples
LLM Resources <-- Automatically added!
├── llms.txt
└── markdown.zip
New Input
| Input | Default | Description |
|---|---|---|
inject-sidebar |
true |
Automatically inject LLM Resources links into the sidebar |
To disable automatic injection, set inject-sidebar: 'false' in your workflow.
Full Changelog
- Added automatic sidebar injection feature
- New
inject-sidebarinput (default:true) - External link icons added to sidebar links
- Updated documentation with sidebar injection examples
- Added troubleshooting section for sidebar issues
Usage
- uses: osodevops/docusaurus-llm-docs@v1
with:
base-url: 'https://your-site.com'
product-name: 'Your Product'
# inject-sidebar: true # enabled by defaultFull documentation: https://github.com/osodevops/docusaurus-llm-docs#readme
v1.0.0 - Initial 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.txtindex for AI navigation - 📦 Markdown Archive: Creates
markdown.zipwith 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.jsfor 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 structuremarkdown.zip- Archive of all documentation as clean markdown files
Perfect for making your Docusaurus documentation accessible to AI assistants and LLMs!