Skip to main content
BarodocBarodoc
GitHub
1 min read

Plugins

LLMs.txt Plugin

Generate llms.txt for AI-friendly documentation

The LLMs.txt plugin generates llms.txt and llms-full.txt files following the llms.txt specification. These files make your documentation easily consumable by AI assistants and large language models.

Installation

pnpm add @barodoc/plugin-llms-txt@latest

Configuration

{
  "plugins": [
    ["@barodoc/plugin-llms-txt", {
      "description": "Documentation for My Project",
      "full": true,
      "links": [
        { "title": "GitHub", "url": "https://github.com/user/repo" },
        { "title": "API Reference", "url": "https://docs.example.com/api" }
      ]
    }]
  ]
}

Generated Files

  • llms.txt — Summary with page titles, descriptions, and links
  • llms-full.txt — Full content of all documentation pages (when full: true)

Options

descriptionstring

Site description for the llms.txt header. Defaults to the site name

fullboolean

Generate llms-full.txt with complete page content. Default: true

linksArray<{ title, url, description? }>

Additional links to include (e.g. GitHub repo, API docs)

Linked pages