Skip to content

Configuration Reference

All configuration options are set under the llms-source plugin in mkdocs.yml.

Options

full_output

  • Type: bool
  • Default: true

Generate /llms-full.txt containing all documentation content concatenated.

plugins:
  - llms-source:
      full_output: false  # Disable llms-full.txt generation

markdown_urls

  • Type: bool
  • Default: true

Copy source .md files into the site output directory, making them accessible at the same URL path as the HTML pages but with a .md extension.

plugins:
  - llms-source:
      markdown_urls: false  # Don't copy .md files to output

description

  • Type: str
  • Default: "" (uses site_description from mkdocs.yml)

Override the description shown in the llms.txt blockquote header.

plugins:
  - llms-source:
      description: "Custom description for LLM consumers"

homepage_notice

  • Type: bool
  • Default: true

Inject a subtle notice at the top of your homepage pointing AI agents to /llms.txt and /llms-full.txt. The notice adapts to light and dark themes and is only added to the rendered HTML — it does not appear in the raw markdown outputs.

plugins:
  - llms-source:
      homepage_notice: false  # Disable the homepage notice

source_revision

  • Type: bool
  • Default: false

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 is obtained via git rev-parse --short HEAD, run in your MkDocs project directory (where mkdocs.yml lives) 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. The llms.txt index is intentionally left unstamped.

If the project is not a git repository — or git is unavailable — the stamp is silently omitted and the build still succeeds (it never fails a build).

plugins:
  - llms-source:
      source_revision: true  # Stamp outputs with the docs git revision

Full Example

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

plugins:
  - search
  - llms-source:
      full_output: true
      markdown_urls: true
      homepage_notice: true
      source_revision: false
      description: "API and usage docs for My Project"

nav:
  - Home: index.md
  - Guides:
    - Getting Started: guides/getting-started.md
    - Advanced Usage: guides/advanced.md
  - API Reference:
    - Overview: api/index.md
    - Endpoints: api/endpoints.md

Requirements

  • site_url must be set in mkdocs.yml for absolute URLs in llms.txt. Without it, the plugin falls back to relative paths and logs a warning.
  • nav should be defined for best results. The plugin auto-derives llms.txt sections from the nav structure. Without nav, MkDocs auto-generates one from the file structure.

Register Your Site

After deploying your site with /llms.txt, consider submitting it to the public llms.txt directories so others can discover it:

This helps grow the ecosystem and makes your documentation more discoverable by AI tools that reference these directories.