Makes LLM-friendly links, headers, meta

Author: nunomaduro

app/Http/Kernel.php

@@ -38,6 +38,7 @@ class Kernel extends HttpKernel
             \App\Http\Middleware\VerifyCsrfToken::class,
             \Illuminate\Routing\Middleware\SubstituteBindings::class,
             \App\Http\Middleware\RedirectRequest::class,
+            \App\Http\Middleware\AddLlmsTxtHeader::class,
         ],
 
         'api' => [

app/Http/Middleware/AddLlmsTxtHeader.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace App\Http\Middleware;
+
+use Closure;
+use Illuminate\Http\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+class AddLlmsTxtHeader
+{
+    public function handle(Request $request, Closure $next): Response
+    {
+        $response = $next($request);
+
+        $baseUrl = 'https://pestphp.com';
+
+        $response->headers->set('X-Llms-Txt', "{$baseUrl}/llms.txt");
+
+        if (preg_match('#^docs/([^/]+)$#', $request->path(), $matches)) {
+            $page = $matches[1];
+            $response->headers->set('Link', "<{$baseUrl}/docs/{$page}/llms.txt>; rel=\"alternate\"; type=\"text/plain\"", false);
+        } else {
+            $response->headers->set('Link', "<{$baseUrl}/llms.txt>; rel=\"llms-txt\"; type=\"text/plain\"", false);
+        }
+
+        return $response;
+    }
+}

public/robots.txt

@@ -1,2 +1,5 @@
 User-agent: *
 Disallow:
+
+# LLM-friendly documentation
+llms-txt: https://pestphp.com/llms.txt

public/www/index.html

@@ -20,6 +20,8 @@
         <meta property="og:description" content="Pest is a testing framework with a focus on simplicity, meticulously designed to bring back the joy of testing in PHP.">
         <meta property="og:url" content="https://pestphp.com">
         <meta property="og:image" content="https://pestphp.com/assets/img/og-v4.jpg">
+        <meta name="llms-txt" content="https://pestphp.com/llms.txt">
+        <link rel="alternate" type="text/plain" href="https://pestphp.com/llms.txt" title="LLM-friendly documentation">
         <link rel="icon" href="/www/favicon.svg" type="image/svg+xml">
         <link rel="preconnect" href="https://fonts.googleapis.com">
         <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>

resources/views/docs.blade.php

@@ -1,4 +1,8 @@
 <x-app-layout layout="app" :title="$matter['title']" :description="$matter['description']">
+    <x-slot name="head">
+        <link rel="alternate" type="text/plain" href="{{ url("/docs/{$page}/llms.txt") }}" title="LLM-friendly version">
+    </x-slot>
+
     <main role="main" class="flex-auto overflow-hidden w-full">
         <section class="documentation">
             <div class="max-w-7xl sm:px-6 lg:flex lg:px-8 mx-auto">

resources/views/layouts/base.blade.php

@@ -33,6 +33,8 @@
         <meta property="og:image" content="https://pestphp.com/assets/img/og-v4.jpg">
     @endif
 
+    <meta name="llms-txt" content="{{ url('/llms.txt') }}">
+
     <meta name="csrf-token" content="{{ csrf_token() }}">
 
     <link rel="icon" href="/www/favicon.svg" type="image/svg+xml">

routes/web.php

@@ -29,4 +29,3 @@
     Route::get('/docs/{page}.md', [LlmsTxtController::class, 'page']);
     Route::get('/docs/{page?}', DocsController::class)->name('docs')->where('page', '.*');
 });
-