mkdocs-llms-source

MkDocs plugin to generate /llms.txt files for LLM-friendly documentation.

What It Does

Generates three outputs from your MkDocs site:

1. /llms.txt — A curated index following the llmstxt.org spec with links to per-page markdown files
2. /llms-full.txt — All documentation concatenated into a single file (for stuffing into LLM context windows)
3. Per-page .md files — Raw markdown accessible at the same URL path as HTML pages

Install

uv add mkdocs-llms-source

Usage

Add to your mkdocs.yml:

site_name: My Project
site_url: https://docs.example.com
site_description: Documentation for My Project

plugins:
  - search
  - llms-source

Build your site:

mkdocs build

The plugin auto-derives the llms.txt section structure from your MkDocs nav — zero extra configuration needed.

Configuration

plugins:
  - llms-source:
      full_output: true           # Generate llms-full.txt (default: true)
      markdown_urls: true         # Copy .md source files to output (default: true)
      description: "Override description for llms.txt header"
      source_revision: false      # Stamp outputs with the docs git revision (default: false)

Source revision stamping

Set source_revision: true to stamp every exported per-page .md file — and llms-full.txt — with a first-line HTML comment recording the docs repo's current git commit:

<!-- rev: a1b2c3d -->
# Your Page Title
...

The short SHA comes from git rev-parse --short HEAD, run in your MkDocs project directory at build time. This lets AI agents and telemetry record exactly which docs revision they fetched, so "it worked yesterday" becomes answerable by diffing two known revisions. llms.txt (the index) is left unstamped.

If the project isn't a git repository — or git isn't available — the stamp is silently omitted and the build still succeeds.

How It Works

Source-first approach: The plugin uses your original markdown source files directly — no HTML-to-Markdown conversion. This is simpler, more reliable, and preserves your intended formatting.

The llms.txt sections are automatically derived from your MkDocs nav configuration, so top-level nav items become H2 sections in the output.

Example Output

Given this nav:

nav:
  - Home: index.md
  - Guides:
    - Getting Started: guides/setup.md

The generated /llms.txt:

# My Project

> Documentation for My Project

## Home

- [My Project](https://docs.example.com/index.md)

## Guides

- [Getting Started](https://docs.example.com/guides/setup.md)

License

MIT