Mkdocs Llmstxt

Overview

The MkDocs llms.txt plugin offers a groundbreaking solution for enhancing how large language models (LLMs) interact with websites by generating a standardized /llms.txt file. This file serves as a crucial resource, allowing LLMs to seamlessly integrate and utilize a website's content during inference. With its simple installation and dynamic capabilities, this plugin is a must-have for developers looking to optimize their documentation for AI interactions.

Using this plugin, developers can ensure that their documentation is readily accessible for LLMs, providing clarity and organization. By converting markdown files into a clean, navigable format, the plugin not only aids in the generation of the /llms.txt file but also allows for a more enriched and structured documentation experience.

Features

• Easy Installation: Simply add the plugin to your mkdocs.yml file to start generating your /llms.txt file immediately.
• Dynamic Content Generation: Automatically generates markdown pages from source files, ensuring that the content is always up-to-date.
• File Globbing Support: Easily include multiple files with file globbing, allowing for flexible content management.
• Markdown Cleanup: Utilizes BeautifulSoup to clean up HTML output before converting it back to markdown, enhancing the readability of generated files.
• Custom Preprocessing: Allows users to pre-process HTML before conversion, offering flexibility to modify the output based on specific file requirements.
• Optional Full Output: Generate a llms-full.txt file to include expanded page content with the additional configuration, improving the utility of the generated documentation.
• Inspiration from Community: Built on the original idea by Petyo Ivanov, fostering a sense of community collaboration in documentation standards.