包简介

Serve LLM-optimized markdown versions of your Laravel pages by appending .md to any URL.

README 文档

README

Serve LLM-optimized markdown versions of your Laravel pages by appending .md to any URL.

Purpose

Large Language Models (LLMs) like ChatGPT and Claude work much better with clean markdown than parsing HTML. This package automatically converts your Laravel pages to markdown, making your site more accessible to AI crawlers, tools, and users who want to feed your content to LLMs.

Features

Automatic Markdown Conversion: Append .md to any URL or use ?format=md
Smart Content Extraction: Configurable CSS selectors find your main content
Table Support: HTML tables converted to GitHub Flavored Markdown tables
Eyebrow Detection: Automatically detects and formats eyebrow/label text
YAML Frontmatter: Includes title, description, URL, and timestamps
Caching: TTL-based caching with artisan command for manual invalidation
llms.txt Endpoint: Spec-compliant sitemap at /llms.txt (llmstxt.org)
Markdown Discovery: Automatic Link header, @llmReady Blade directive, and llmReadyUrl() helper
Route Exclusions: Pattern-based exclusions for admin, API, and other routes
Redirect Handling: Automatically follows redirects (e.g., /blog -> /blog/)
Extensible: Swap the content extractor with your own implementation

Requirements

PHP 8.4+
Laravel 12.x

Installation

composer require daikazu/laravel-llm-ready

The package will auto-discover and register itself.

Publish Configuration (Optional)

php artisan vendor:publish --tag=llm-ready-config

Server Configuration

Your web server needs to pass .md requests to Laravel instead of trying to serve them as static files.

Apache

The default Laravel .htaccess should work. Ensure it contains:

<IfModule mod_rewrite.c>
    RewriteEngine On
    RewriteCond %{REQUEST_FILENAME} !-d
    RewriteCond %{REQUEST_FILENAME} !-f
    RewriteRule ^ index.php [L]
</IfModule>

Nginx

Add this to your server block:

location ~ \.md$ {
    try_files /index.php?$query_string =404;
    fastcgi_pass unix:/var/run/php/php-fpm.sock;
    fastcgi_param SCRIPT_FILENAME $document_root/index.php;
    include fastcgi_params;
}

Laravel Valet/Herd

Works out of the box - no configuration needed.

Usage

Accessing Markdown Versions

There are three ways to get the markdown version of a page:

# Method 1: Append .md extension
https://yoursite.com/about-us.md

# Method 2: Use ?format=md query parameter
https://yoursite.com/?format=md
https://yoursite.com/about-us?format=md

# Method 3: Use index.md for index pages
https://yoursite.com/index.md        # Home page
https://yoursite.com/blog/index.md   # Blog index

llms.txt Endpoint

The /llms.txt endpoint follows the llmstxt.org specification, providing LLMs with structured information about your site:

https://yoursite.com/llms.txt

Example output:

# Your Site Name

> A brief description of your site.

All pages on this site are available in markdown format for LLM consumption.
Append `.md` to any URL or add `?format=md` to get the markdown version.

## Documentation

- [Getting Started](https://yoursite.com/docs/getting-started)
- [API Reference](https://yoursite.com/docs/api)

## Pages

- [Home](https://yoursite.com)
- [About](https://yoursite.com/about)
- [Blog](https://yoursite.com/blog)

Markdown Discovery

LLMs and crawlers need a way to discover that a markdown version of a page exists. This package provides three complementary mechanisms:

Automatic Link Header

Every HTML response automatically includes a Link header pointing to the markdown version:

Link: <https://yoursite.com/about.md>; rel="alternate"; type="text/markdown"

This is enabled by default. Disable it via config or environment variable:

LLM_READY_LINK_HEADER=false

Blade Directive

Add a <link> tag to your templates so crawlers can discover the markdown version via HTML:

<head>
    @llmReady
    {{-- Outputs: <link rel="alternate" type="text/markdown" href="https://yoursite.com/about.md"> --}}
</head>

The directive is opt-in — it only outputs when you use it, and returns an empty string for excluded routes or when the package is disabled.

Helper Function

Use llmReadyUrl() in programmatic contexts like SEO middleware (e.g., romanzipp/laravel-seo):

// Returns "https://yoursite.com/about.md" or null if excluded/disabled
$markdownUrl = llmReadyUrl();

Clear Cache

# Clear all LLM Ready caches
php artisan llm-ready:clear-cache

# Clear cache for a specific URL
php artisan llm-ready:clear-cache --url=https://yoursite.com/about-us

# Clear only the sitemap cache
php artisan llm-ready:clear-cache --sitemap

Configuration

// config/llm-ready.php

return [
    // Enable/disable the package
    'enabled' => env('LLM_READY_ENABLED', true),

    // Cache settings
    'cache' => [
        'enabled' => env('LLM_READY_CACHE_ENABLED', true),
        'ttl' => env('LLM_READY_CACHE_TTL', 1440), // 24 hours in minutes
        'prefix' => 'llm_ready',
    ],

    // CSS selectors to find main content (tried in order)
    'content_selectors' => [
        'main',
        'article',
        '[role="main"]',
        '.content',
    ],

    // Elements to remove before conversion
    'ignore_selectors' => [
        'nav',
        'header',
        'footer',
        'aside',
        '.sidebar',
        'script',
        'style',
    ],

    // Eyebrow/label text detection
    'eyebrow_selectors' => [
        '.eyebrow',
        '.overline',
        '.kicker',
        '[class*="eyebrow"]',
    ],
    'eyebrow_auto_detect' => true,

    // Routes to exclude from markdown conversion (supports nested paths)
    'exclude_patterns' => [
        '/admin/*',    // Matches /admin/users, /admin/settings/email, etc.
        '/api/*',      // Matches /api/v1/users, /api/webhooks/stripe, etc.
        '/livewire/*',
    ],

    // Markdown discovery settings
    'discovery' => [
        'link_header' => env('LLM_READY_LINK_HEADER', true),
    ],

    // llms.txt configuration (follows llmstxt.org spec)
    'llms_txt' => [
        'enabled' => true,
        'cache_ttl' => 60,
        'title' => env('LLM_READY_LLMS_TXT_TITLE'), // Defaults to app name
        'summary' => env('LLM_READY_LLMS_TXT_SUMMARY'),
        'description' => [],
        'sections' => [
            // 'Documentation' => [
            //     ['url' => '/docs/intro.md', 'description' => 'Introduction'],
            // ],
        ],
        'auto_section' => [
            'enabled' => true,
            'title' => 'Pages',
        ],
    ],

    // YAML frontmatter settings
    'frontmatter' => [
        'include_title' => true,
        'include_description' => true,
        'include_url' => true,
        'include_last_modified' => true,
    ],

    // Custom content extractor class
    'extractor' => \Daikazu\LaravelLlmReady\Extractors\DefaultContentExtractor::class,
];

Output Example

Requesting /about-us.md produces clean markdown:

---
title: About Us - Your Company Name
description: Learn about our mission and team
url: https://yoursite.com/about-us
last_modified: 2024-01-15T10:30:00+00:00
---

# About Us

Welcome to our company! We're dedicated to...

## Our Mission

We believe in creating value for our customers through...

## Our Team

| Name | Role | Experience |
|------|------|------------|
| Jane Doe | CEO | 15 years |
| John Smith | CTO | 12 years |

Configuring llms.txt

The llms.txt endpoint can be fully customized to provide curated information to LLMs:

'llms_txt' => [
    'title' => 'Acme Documentation',
    'summary' => 'Complete documentation for the Acme platform.',
    'description' => [
        'Acme helps developers build better applications faster.',
        'Our documentation covers installation, configuration, and advanced usage.',
    ],
    'sections' => [
        'Getting Started' => [
            ['url' => '/docs/installation', 'description' => 'How to install Acme'],
            ['url' => '/docs/quickstart', 'description' => '5-minute quickstart guide'],
        ],
        'API Reference' => [
            ['url' => '/docs/api/authentication', 'description' => 'Authentication methods'],
            ['url' => '/docs/api/endpoints', 'description' => 'Available API endpoints'],
        ],
    ],
    'auto_section' => [
        'enabled' => true,
        'title' => 'All Pages',
        'include_in_optional' => false,
    ],
],

Custom Content Extractor

Create your own extractor by implementing ContentExtractorInterface:

<?php

namespace App\LlmReady;

use Daikazu\LaravelLlmReady\Contracts\ContentExtractorInterface;
use DOMDocument;

class CustomContentExtractor implements ContentExtractorInterface
{
    public function extract(DOMDocument $dom, array $contentSelectors, array $ignoreSelectors): string
    {
        // Your custom extraction logic
    }
}

Then update your config:

'extractor' => \App\LlmReady\CustomContentExtractor::class,

Environment Variables

LLM_READY_ENABLED=true
LLM_READY_CACHE_ENABLED=true
LLM_READY_CACHE_TTL=1440
LLM_READY_LLMS_TXT_ENABLED=true
LLM_READY_LLMS_TXT_CACHE_TTL=60
LLM_READY_LINK_HEADER=true
LLM_READY_LLMS_TXT_TITLE="My Site"
LLM_READY_LLMS_TXT_SUMMARY="A brief description of my site."

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

daikazu/laravel-llm-ready 适用场景与选型建议

daikazu/laravel-llm-ready 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 140 次下载、GitHub Stars 达 2，最近一次更新时间为 2026 年 01 月 13 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「laravel」「daikazu」「laravel-llm-ready」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 daikazu/laravel-llm-ready 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 daikazu/laravel-llm-ready 我们能提供哪些服务？

定制开发 / 二次开发

基于 daikazu/laravel-llm-ready 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 daikazu/laravel-llm-ready 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

daikazu/laravel-glider 92

Start using Glide on-the-fly instantly in your Laravel blade templates.

daikazu/filament-image-checkbox-group 4

Image-based checkbox group component for FilamentPHP

daikazu/filament-lightbox 2

This is my package filament-lightbox

foxtes/alfabank-rest 1

Alfabank REST API integration

daikazu/breadcrumbs 0

Route-aware breadcrumb management for Laravel

daikazu/asi-smartlink 0

A typed PHP client for the ASI Smartlink REST API, built on Saloon, with fluent query builders, immutable DTOs, typed exceptions, and optional Laravel integration.

daikazu/laravel-llm-ready

包简介

关键字：

README 文档

README

Serve LLM-optimized markdown versions of your Laravel pages by appending .md to any URL.

Purpose

Features

Requirements

Installation

Publish Configuration (Optional)

Server Configuration

Apache

Nginx

Laravel Valet/Herd

Usage

Accessing Markdown Versions

llms.txt Endpoint

Markdown Discovery

Automatic Link Header

Blade Directive

Helper Function

Clear Cache

Configuration

Output Example

Configuring llms.txt

Custom Content Extractor

Environment Variables

Testing

Changelog

Contributing

Security Vulnerabilities

Credits

License

daikazu/laravel-llm-ready 适用场景与选型建议

与 daikazu/laravel-llm-ready 相关的其它包

统计信息

GitHub 信息

其他信息