# 📜 docusaurus-plugin-llms

A Docusaurus plugin for generating LLM-friendly documentation following the [llmstxt standard](https://llmstxt.org/).

[![npm version](https://img.shields.io/npm/v/docusaurus-plugin-llms.svg)](https://www.npmjs.com/package/docusaurus-plugin-llms)
[![npm downloads](https://img.shields.io/npm/dm/docusaurus-plugin-llms.svg)](https://www.npmjs.com/package/docusaurus-plugin-llms)
[![CI](https://github.com/rachfop/docusaurus-plugin-llms/actions/workflows/ci.yml/badge.svg)](https://github.com/rachfop/docusaurus-plugin-llms/actions/workflows/ci.yml)
[![Docs](https://img.shields.io/website?url=https%3A%2F%2Frachfop.github.io%2Fdocusaurus-plugin-llms%2Fdocs%2Foverview&label=docs)](https://rachfop.github.io/docusaurus-plugin-llms/)
[![GitHub Sponsors](https://img.shields.io/github/sponsors/rachfop?style=flat&logo=githubsponsors&label=Sponsor&labelColor=gray&color=pink)](https://github.com/sponsors/rachfop)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

During a production build, this plugin scans your Docusaurus docs and writes an `llms.txt` file linking every documentation section plus an `llms-full.txt` file bundling all your content into one document. That lets LLMs consume your docs without parsing HTML. It works with zero configuration and stays out of your way until you need to customize it.

## Features

- Generates `llms.txt` with section links and `llms-full.txt` with all content in one file.
- Optionally writes individual `.md` files per page for closer llmstxt.org compliance.
- Controls document order and transforms URLs with glob patterns.
- Cleans content for LLMs: strips HTML, removes import statements, and drops duplicate headings.
- Rewrites relative image paths to absolute build-output URLs.
- Supports custom LLM files, multi-instance docs, and multi-version output.

## Getting started

Install the plugin as a dev dependency:

```bash
npm install docusaurus-plugin-llms --save-dev
```

Register it in `docusaurus.config.js`:

```js
module.exports = {
  // ... your existing Docusaurus config
  plugins: [
    'docusaurus-plugin-llms',
    // ... your other plugins
  ],
};
```

On your next `npm run build`, the plugin writes `llms.txt` and `llms-full.txt` into the build output. That's the whole zero-config setup. See [installation](https://rachfop.github.io/docusaurus-plugin-llms/docs/installation) to confirm it worked, then [configuration options](https://rachfop.github.io/docusaurus-plugin-llms/docs/configuration) when you're ready to customize.

## Documentation

The docs are published at [rachfop.github.io/docusaurus-plugin-llms](https://rachfop.github.io/docusaurus-plugin-llms), a Docusaurus site that runs this plugin on its own documentation. Its [llms.txt](https://rachfop.github.io/docusaurus-plugin-llms/llms.txt) is live dogfood output.

- [Overview](https://rachfop.github.io/docusaurus-plugin-llms/docs/overview): what the plugin generates and how it runs.
- [Installation](https://rachfop.github.io/docusaurus-plugin-llms/docs/installation): install the package and register it with a zero-config setup.
- [Configuration options](https://rachfop.github.io/docusaurus-plugin-llms/docs/configuration): the full reference for every option the plugin accepts.
- [Generating content](https://rachfop.github.io/docusaurus-plugin-llms/docs/content-generation): multiple doc sections, custom root content, custom LLM files, and partials.
- [Generating individual Markdown files](https://rachfop.github.io/docusaurus-plugin-llms/docs/markdown-files): what `generateMarkdownFiles` produces and how files are named and laid out.
- [Content cleaning](https://rachfop.github.io/docusaurus-plugin-llms/docs/content-cleaning): strip HTML, remove imports, drop duplicate headings, and rewrite image URLs.
- [Ordering and path transformation](https://rachfop.github.io/docusaurus-plugin-llms/docs/ordering-and-paths): control document order, transform URLs, and tune batch processing.
- [Multi-version output](https://rachfop.github.io/docusaurus-plugin-llms/docs/multi-version): publish a separate set of LLM files per documentation version.
- [Best practices](https://rachfop.github.io/docusaurus-plugin-llms/docs/best-practices): recommended option combinations for common documentation shapes.

## License

This project is licensed under the MIT License.