What is llms.txt and why is it important?

llms.txt is a proposed file placed at the root of a website (/llms.txt) in Markdown format to guide LLMs through the site's most important content in a clear, structured way. It exists because HTML pages are often cluttered with ads, navigation, scripts, or dynamic content. LLMs benefit from curated, plain-text summaries that fit their context window limits.

How do I validate my llms.txt file?

You can validate your llms.txt file using our free online validator. Simply enter your website URL (e.g., example.com/llms.txt) or paste your file content directly into the validator. The tool will check for required elements like H1 headers, blockquote summaries, H2 sections, and valid URL formats.

What's the difference between llms.txt and llms-full.txt?

llms.txt contains structured links to your important pages with descriptions, while llms-full.txt is a companion file that includes full plain-text content of documentation. llms-full.txt is useful when LLMs can ingest large context without navigating individual pages, but may exceed context windows.

Is this llms.txt validator free to use?

Yes! Our llms.txt validator is completely free to use. No registration required, no limits on usage. We're committed to helping the web become more AI-friendly.

What are the common errors in llms.txt files?

Common errors include: missing H1 header, missing blockquote summary, no H2 sections, broken or malformed URLs, duplicate URL entries, incorrect Markdown formatting, and files that are too large (>500KB). Our validator checks for all these issues and provides detailed error messages.

LLMs.txt Examples & Templates

Learn from real examples of properly formatted llms.txt files. Download, study, and adapt these templates for your own projects.

←Back to Validator

Valid llms.txt

Perfect structure example

This example demonstrates the correct format with all required elements: H1 header, blockquote summary, H2 sections with links, and optional sections.

Validate

llms.txt

1# My Project
2
3> A comprehensive toolkit for modern web development with best practices and useful utilities.
4
5## Documentation
6- [Getting Started](https://example.com/docs/): Complete guide to get up and running
7- [API Reference](https://example.com/api/): Detailed API documentation
8- [Tutorial](https://example.com/tutorial/): Step-by-step tutorial
9
10## Examples
11- [Code Examples](https://example.com/examples/): Real-world usage examples
12- [Sample Apps](https://example.com/apps/): Complete application demos
13
14## Community
15- [GitHub Repository](https://example.com/github/): Source code and issues
16- [Discussions](https://example.com/discussions/): Community support and questions
17
18## Optional
19- [Release Notes](https://example.com/releases/): Latest changes and updates
20- [Blog](https://example.com/blog/): News and announcements

llms-full.txt

Complete documentation example

An example of llms-full.txt format with comprehensive documentation content, code examples, and detailed explanations in one file.

Validate

llms-full.txt

1# Complete Project Documentation
2
3> This is a comprehensive documentation file that contains all the essential information about our project in one place.
4
5## Quick Start
6
7To get started with our project, you'll need to install the dependencies and configure your environment.
8
9### Installation
10
11```bash
12npm install my-project
13```
14
15### Basic Usage
16
17```javascript
18import { MyProject } from 'my-project'
19
20const project = new MyProject({
21  apiKey: 'your-api-key',
22  environment: 'development'
23})
24```
25
26## API Reference
27
28### Core Methods
29
30#### `initialize(options)`
31
32Initializes the project with the given options.
33
34**Parameters:**
35- `options` (Object): Configuration options
36  - `apiKey` (string): Your API key
37  - `environment` (string): 'development' or 'production'
38
39**Returns:** Promise<void>
40
41#### `getData(query)`
42
43Retrieves data based on the provided query.
44
45**Parameters:**
46- `query` (string): Search query
47
48**Returns:** Promise<Array>
49
50## Configuration
51
52The project can be configured using environment variables or a configuration file.
53
54### Environment Variables
55
56- `API_KEY`: Your API key
57- `ENVIRONMENT`: development or production
58- `DEBUG`: Enable debug logging
59
60### Configuration File
61
62Create a `config.json` file in your project root:
63
64```json
65{
66  "apiKey": "your-api-key",
67  "environment": "development",
68  "timeout": 5000
69}
70```
71
72## Best Practices
73
741. Always validate your API key before making requests
752. Use error handling for all async operations
763. Implement proper logging for debugging
774. Follow security best practices for API keys
78
79## Troubleshooting
80
81### Common Issues
82
83**Issue:** API key not working
84**Solution:** Verify your API key is correct and has proper permissions
85
86**Issue:** Timeout errors
87**Solution:** Increase timeout value in configuration
88
89**Issue:** Rate limiting
90**Solution:** Implement exponential backoff for retries

How to Use These Examples

📝 Getting Started

1. Download the example that matches your needs
2. Replace placeholder content with your project details
3. Update all URLs to point to your actual pages
4. Upload to your website's root directory as /llms.txt
5. Test with our validator to ensure it's correctly formatted

🎯 Best Practices

• Keep descriptions concise but informative
• Use HTTPS URLs whenever possible
• Regularly update content to stay current
• Test all links to ensure they work
• Consider both llms.txt and llms-full.txt based on your needs

💡 Pro Tip: Start with the valid example and customize it for your project. The validator will help you catch any formatting issues as you make changes.