mdbook-llms-txt

A tool to convert mdbook documents to llmstxt.org format.

Overview

This tool is a renderer that converts documents created with mdbook into llmstxt.org format. This allows you to share technical documentation created with mdbook in a format optimized for LLMs.

Features

Implemented Features

• ✅ Basic llms.txt rendering
• ✅ llms-full.txt rendering with detailed information

Planned Features

• 🚧 Additional metadata support specifically for llms.txt format

Installation

cargo install mdbook-llms-txt-tools

Usage

1. Add the following configuration to your project's book.toml:

# Basic llmstxt.org format output
[output.llms-txt]

# Detailed llmstxt.org format output with additional information
[output.llms-full-txt]

2. Run mdbook build as usual, and files will be generated in your chosen output format.

Output Formats

• llms-txt: Generates basic llmstxt.org format output. Suitable for general use.
• llms-full-txt: Generates llmstxt.org format output with more detailed information. Use this when more advanced analysis or processing is needed.

License

MIT

Contributing

Please report bugs and feature requests on GitHub Issues. Pull requests are welcome.