mkdocs-llmstxt

What it is and what it does

mkdocs-llmstxt is a MkDocs plugin that generates a standardized /llms.txt file at your documentation root. This file provides structured information about your site to help large language models understand and use your documentation more effectively at inference time. The plugin works by rendering your MkDocs pages to HTML, cleaning up the output with BeautifulSoup, and converting it back to Markdown using Markdownify—this ensures dynamically generated content like API docs and Jinja macros are included.

You configure it in mkdocs.yml by specifying sections and files to include, and optionally enable full-page output via llms-full.txt. The plugin supports file globbing for flexible section organization and allows preprocessing of HTML before conversion. It's built on four core dependencies: beautifulsoup4, markdownify, mdformat, and mdformat-tables, all of which handle the HTML parsing and Markdown formatting.

Use it for:

• Generate standardized /llms.txt for AI assistants to better understand your project structure and documentation.
• Create a machine-readable documentation index for LLM-based code assistants and documentation chatbots.
• Publish full-page Markdown versions of your docs for AI training or consumption without manual conversion.
• Support multiple documentation versions or languages by using base_url to point LLMs to version-specific docs.
• Automatically include dynamically generated API documentation in the /llms.txt without manual updates.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

MkDocs plugin that generates an /llms.txt file at your documentation root to help LLMs understand and navigate your site at inference time.

Yes. The plugin solves a real problem—making your MkDocs documentation discoverable and usable by LLMs—with low install friction, active maintenance, no security issues, and a permissive license. Install it if you want LLMs and AI tools to have better access to your documentation.

Install

mkdocs-llmstxt on PyPI

pip install mkdocs-llmstxt

uv add mkdocs-llmstxt

poetry add mkdocs-llmstxt

Installing mkdocs-llmstxt

Before you install

Low friction install with four straightforward runtime dependencies. The project is actively maintained with a recent release and no known vulnerabilities.

License in practice

ISC permissive license allows commercial and private use with minimal restrictions.

Quickstart

pip install mkdocs-llmstxt

Then in mkdocs.yml:
plugins:
- llmstxt:
    markdown_description: Long description of my project.
    sections:
      Usage documentation:
      - file1.md: Description of file1
      - file2.md

Requires Python 3.10 or later; site_url must be configured in mkdocs.yml for the plugin to work.

Verify before relying

• Whether the plugin handles complex MkDocs themes or custom CSS that might affect HTML-to-Markdown conversion quality.
• Performance impact when processing large documentation sites with many pages.

Package facts

Evidence: mkdocs_llmstxt-0.5.0-py3-none-any.whl

Tags

More Software Development packages

Further reading