README

LLM Ready makes your Craft CMS site machine-readable by serving clean Markdown versions of your content to AI crawlers and LLMs. Append .md to any entry URL, and LLM Ready converts the page to Markdown with YAML front matter — no extra templates required.

For complete documentation, see the LLM Ready Documentation in this repo.

Using an AI coding assistant? Point your agent to AI-INSTALL.md for automated installation and configuration.

Highlights

Zero configuration required — works out of the box with no template changes. Install the plugin and your content is immediately available as Markdown.
Append .md to any entry URL to get a clean Markdown version using your existing URLs — no separate URL prefix needed.
Automatic AI bot detection — transparently serves Markdown to known AI crawlers (GPTBot, ClaudeBot, PerplexityBot, and others) without any action from the visitor.
Three detection methods: .md URL suffix, Accept: text/markdown content negotiation, and AI bot user-agent detection.
Smart HTML-to-Markdown conversion extracts main content and strips navigation, footers, scripts, and other non-content elements — no template tags to add.
Optionally assign dedicated Twig templates per section that output raw Markdown for full control.
Real-time rendering — Markdown is generated on demand and cached, so content is always up to date without queue jobs or batch generation.
Auto-generates a /llms.txt site index following the llms.txt specification.
Listing page support — append .md to a section's base URL to get a Markdown index of entries.
YAML front matter with entry metadata (title, date, author, canonical URL, section).
Auto-injects <link rel="alternate" type="text/markdown"> discovery tags into HTML pages.
Project config support — per-section settings are stored in Craft's project config for version control and multi-environment sync.
Per-section enable/disable control from the plugin settings page.
Caches Markdown output with automatic invalidation when entries are saved.
X-Robots-Tag: noindex header prevents search engines from indexing Markdown responses.

Requirements

This plugin requires Craft CMS 5.5.0 or later, and PHP 8.2 or later.

Installation

You can install this plugin from the Plugin Store or with Composer.

Using an AI coding assistant? See AI-INSTALL.md for a step-by-step guide your agent can follow to install, verify, and configure the plugin automatically.

From the Plugin Store

Go to the Plugin Store in your project's Control Panel and search for "LLM Ready". Then press "Install".

With Composer

Open your terminal and run the following commands:

# go to the project directory
cd /path/to/my-project.test

# tell Composer to load the plugin
composer require johnfmorton/craft-llm-ready

# tell Craft to install the plugin
./craft plugin/install llm-ready

johnfmorton / craft-llm-ready

Maintainers

Package info

Statistics