原始内容
llms.txt Generator
Generate /llms.txt files for any project following the llmstxt.org specification.
📄 What is llms.txt?
The /llms.txt file is a proposed standard by Jeremy Howard to help LLMs understand and use websites/projects efficiently. Think of it as robots.txt but for AI assistants.
Instead of crawling entire sites, LLMs can read a single markdown file that provides:
- Project overview and context
- Links to key documentation
- Organized resources by category
- Guidance on what's important vs optional
📦 Installation
npx skills add marcelo-earth/llms-txt-generator
🚀 Usage
Once installed, you can invoke the skill in Claude Code:
/llms-txt
Or mention the llms-txt skill in your prompt:
- "Use llms-txt to document this project"
- "Generate an llms.txt for this repo"
- "Create LLM-friendly documentation with llms-txt"
⚡ What the Skill Does
- Analyzes your project - Scans for README, docs, examples, API references
- Identifies key resources - Finds what's important for understanding the project
- Generates llms.txt - Creates a properly formatted file following the spec
📝 Example Output
# My Project
> A brief description of what this project does and why it exists.
Important notes:
- Key caveat or compatibility information
- Another critical detail
## Docs
- [Getting Started](https://github.com/marcelo-earth/llms-txt-generator/blob/HEAD/docs/getting-started.md): Installation and basic usage
- [API Reference](https://github.com/marcelo-earth/llms-txt-generator/blob/HEAD/docs/api.md): Complete function reference
## Examples
- [Basic Usage](https://github.com/marcelo-earth/llms-txt-generator/blob/HEAD/examples/basic.py): Simple example to get started
## Optional
- [Advanced Config](https://github.com/marcelo-earth/llms-txt-generator/blob/HEAD/docs/advanced.md): For power users
🤔 Why No Scripts?
This skill doesn't include executable scripts because:
- The work is intelligent, not mechanical - Deciding what to include requires understanding the project
- Claude already has the tools - Glob, Grep, Read are sufficient for analysis
- The output is simple - Just markdown with a specific structure
The value is in the judgment of what to include, not in processing files.
🤲 Contributing
This is an open source project. If you want to improve the skill, fix a bug, or add new features:
- Fork the repository
- Make your changes
- Submit a pull request
📚 Resources
- llmstxt.org - The official specification
- skills.sh - Skills marketplace
- Claude Code Docs - How skills work