web-vision / ai-llms-txt
TYPO3 extension for generating .well-known/llm.txt files according to llmstxt.org specification
Installs: 1
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
Type:typo3-cms-extension
pkg:composer/web-vision/ai-llms-txt
Requires
- php: ^8.3
- league/html-to-markdown: ^5.1
- typo3/cms-backend: ^13.0
- typo3/cms-core: ^13.0
- typo3/cms-extbase: ^13.0
- typo3/cms-fluid: ^13.0
- typo3/cms-seo: ^13.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.0
- helhum/typo3-console: ^8.2
- phpstan/phpstan: ^1.10
- phpunit/phpunit: ^10.0 || ^11.0
- saschaegerer/phpstan-typo3: ^1.10
- typo3/cms-fluid-styled-content: ^13.4
- typo3/coding-standards: ^0.8
- typo3/testing-framework: ^8.0
README
TYPO3 extension for generating llms.txt links according to the llmstxt.org specification to control Large Language Model crawling policies.
Features
- Automatic llms.txt generation - Creates policy files according to the official specification
- Site navigation structure - Includes your site's navigation hierarchy in the llms.txt file
- Configurable metadata - Add topics, contact information, and custom descriptions
- Markdown export - Convert any TYPO3 page to Markdown format via
.mdsuffix - TYPO3 v13 compatibility - Built specifically for TYPO3 v13 using modern PHP practices
What is llms.txt?
llms.txt is an emerging standard for websites to communicate with Large Language Models and AI systems. Similar to robots.txt for web crawlers, llms.txt files provide:
- Crawling policies - Guidelines for AI systems on how to interact with your content
- Site structure - Navigation and content organization information
- Metadata - Topics, contact information, and site descriptions
- Content access - Direct links to machine-readable content formats
Installation
Composer (Recommended)
composer require web-vision/ai-llms-txt
Quick Start
After installation, the extension works immediately with default settings:
- llms.txt generation: Visit
https://yoursite.com/?type=1699 - Markdown pages: Visit
https://yoursite.com/?type=1701
with Route Enhancer:
- llms.txt file: Visit
https://yoursite.com/.well-known/llms.txt - Markdown pages: Add
.mdto any page URL (e.g.,https://yoursite.com/about.md)
Configuration
All settings can be configured in your site configuration.
Route Configuration
To enable user-friendly URLs, include the route enhancers in your site configuration:
# config/sites/main/config.yaml imports: - resource: 'EXT:ai_llms_txt/Configuration/Routes/RouterEnhancer.yaml'
This enables:
.mdsuffix for Markdown contentllms.txtfor direct access to the specification file
Usage Examples
Accessing Generated Content
llms.txt files:
https://yoursite.com/?type=1699https://yoursite.com/.well-known/llms.txt- with route enhancerhttps://yoursite.com/llms.txt- Alternative access (with route enhancer)
Markdown content:
https://yoursite.com/?type=1701https://yoursite.com/about.md- Markdown version of your About pagehttps://yoursite.com/services/consulting.md- Markdown version of any page
Requirements
- TYPO3: 13.0 or higher
- PHP: 8.3 or higher
- Dependencies: league/html-to-markdown (automatically installed)
Documentation
Comprehensive documentation is available covering:
Contributing
Contributions are welcome! Please:
- Follow TYPO3 coding standards
- Include tests for new features
- Update documentation for configuration changes
- Use dependency injection patterns
- Maintain strict typing
License
This extension is licensed under GPL v2+ - see the LICENSE file for details.
Support
- Documentation: Full documentation in the
Documentation/folder - Issues: Report issues via the project issue tracker
- Community: Join TYPO3 community discussions for general TYPO3 support
Related
- llmstxt.org - Official specification
- TYPO3 Documentation - TYPO3 CMS documentation