mdbook-llms-txt-tools
| Crates.io | mdbook-llms-txt-tools |
| lib.rs | mdbook-llms-txt-tools |
| version | 0.1.1 |
| created_at | 2025-02-22 16:55:23.38941+00 |
| updated_at | 2025-02-23 04:19:21.786116+00 |
| description | A tool to convert mdbook to llmstxt.org format |
| homepage | |
| repository | https://github.com/higumachan/mdbook-llms-txt-tools |
| max_upload_size | |
| id | 1565569 |
| size | 112,594 |
Yuta Hinokuma (higumachan)
documentation
README
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
- 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]
- Run
mdbook buildas 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.