PHPackages                             tomstgeorge/silverstripe-llm-markdown - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Parsing & Serialization](/categories/parsing)
4. /
5. tomstgeorge/silverstripe-llm-markdown

ActiveSilverstripe-vendormodule[Parsing & Serialization](/categories/parsing)

tomstgeorge/silverstripe-llm-markdown
=====================================

Generates llm.txt and Markdown versions of pages for AI agents, building on staticpublishqueue.

2.x-dev(2mo ago)043BSD-3-ClausePHPPHP ^8.3

Since Apr 21Pushed 2mo agoCompare

[ Source](https://github.com/tomstgeorge/silverstripe-llm-markdown)[ Packagist](https://packagist.org/packages/tomstgeorge/silverstripe-llm-markdown)[ RSS](/packages/tomstgeorge-silverstripe-llm-markdown/feed)WikiDiscussions main Synced today

READMEChangelogDependencies (8)Versions (4)Used By (0)

Silverstripe LLM Markdown
=========================

[](#silverstripe-llm-markdown)

Generates `llm.txt` and Markdown (`.md`) versions of all statically published pages for AI agents. Builds on [silverstripe/staticpublishqueue](https://github.com/silverstripe/silverstripe-staticpublishqueue): when a page is published and the static cache is built, this module also writes a `.md` file alongside each `.html` file and can regenerate a single `llm.txt` from all markdown.

Features
--------

[](#features)

- **Per-page Markdown**: For every URL that gets a static `.html` file, a `.md` file is written to the same path (e.g. `index.md`, `about-us.md`) using HTML-to-Markdown conversion.
- **Purge on unpublish**: When a URL is purged from the static cache, the corresponding `.md` file is removed.
- **llm.txt**: A build task regenerates a single `llm.txt` in the cache root from all `.md` files (one `## URL` section per page).
- **Serving Markdown to agents**: An optional static request handler serves `.md` when the request has `Accept: text/markdown` or `Accept: text/plain`, otherwise delegates to the normal static HTML handler.

Requirements
------------

[](#requirements)

- PHP ^8.1
- Silverstripe Framework ^5.0, CMS ^5.0
- [silverstripe/staticpublishqueue](https://github.com/silverstripe/silverstripe-staticpublishqueue) ^6.3
- [league/html-to-markdown](https://github.com/thephpleague/html-to-markdown) ^5.1

Dependencies are installed at the project level (in your root `vendor/`), not inside the module.

Installation
------------

[](#installation)

Install the module and its dependencies via Composer:

```
composer require tomstgeorge/silverstripe-llm-markdown
```

If you use a path repository for local development:

```
{
  "repositories": [
    {
      "type": "path",
      "url": "./silverstripe-llm-markdown-src",
      "options": { "symlink": true }
    }
  ],
  "require": {
    "tomstgeorge/silverstripe-llm-markdown": "@dev"
  }
}
```

Then run `composer update`. Ensure the module folder is **not** also present under the same name at the project root (e.g. use a name like `silverstripe-llm-markdown-src` for the path repo) to avoid duplicate class errors.

Usage
-----

[](#usage)

### Automatic behaviour

[](#automatic-behaviour)

- **Publishing**: When you publish a page, the static publish queue runs as usual. This module’s publisher extension runs after each URL is generated and writes the same path with a `.md` extension (same directory as the `.html` files, typically under your static cache folder).
- **Unpublishing / purge**: When a URL is purged from the static cache, the matching `.md` file is deleted.

No extra configuration is required for per-page markdown generation; it works with your existing staticpublishqueue setup.

### Regenerating llm.txt

[](#regenerating-llmtxt)

After a full static cache build (or whenever you want to refresh the combined file), run the build task:

- **URL**: `https://yoursite.com/dev/tasks/RegenerateLLMTxtTask`
- **CLI**: `vendor/bin/sake dev/tasks/RegenerateLLMTxtTask`

This scans all `.md` files in the static cache and writes `llm.txt` in the cache root, with one `## ` section per page.

### Serving Markdown to clients that request it

[](#serving-markdown-to-clients-that-request-it)

The module **does not modify** `public/index.php` or any core Silverstripe files. Like StaticPublishQueue (which provides a static handler file but does not wire it into your project), you choose whether to serve static cache from your front controller.

To serve cached HTML and Markdown (so that requests with `Accept: text/markdown` or `Accept: text/plain` get the `.md` file, and others get `.html`), use the **same cache directory as StaticPublishQueue**: get it from the Publisher after booting the kernel, then run the module’s static handler before handling the request. Example for `public/index.php`:

```
// After require autoload.php:
$request = HTTPRequestBuilder::createFromEnvironment();
$kernel = new CoreKernel(BASE_PATH);
$kernel->boot();

// Static cache: serve .md for Accept text/markdown|text/plain, else .html (optional – requires tomstgeorge/silverstripe-llm-markdown)
$publisher = \SilverStripe\StaticPublishQueue\Publisher::singleton();
if ($publisher instanceof \SilverStripe\StaticPublishQueue\Publisher\FilesystemPublisher) {
    $cacheDir = $publisher->getDestPath();
    $staticHandlerPath = __DIR__ . '/../vendor/tomstgeorge/silverstripe-llm-markdown/includes/staticrequesthandler.php';
    if (is_file($staticHandlerPath)) {
        $staticHandler = require $staticHandlerPath;
        if ($staticHandler($cacheDir)) {
            exit;
        }
    }
}

$app = new HTTPApplication($kernel);
$response = $app->handle($request);
$response->output();
```

The handler will:

- Serve the `.md` file with `Content-Type: text/markdown; charset=utf-8` when the request includes `Accept: text/markdown` or `Accept: text/plain`.
- Otherwise delegate to the staticpublishqueue handler (serve `.html` or fall through).

Using `$publisher->getDestPath()` ensures the cache directory matches the one used by the static publisher (same as `FilesystemPublisher`’s dest path, including any custom `destFolder` config).

Configuration
-------------

[](#configuration)

The module replaces the static publish queue’s publisher with `TomStGeorge\LLMMarkdown\Publisher\LLMMarkdownPublisher` and attaches the markdown extension. Your existing `staticpublishqueue` config (e.g. `disallowed_status_codes`, `regenerate_children` / `regenerate_parents`) still applies.

### Regenerating llm.txt after each job

[](#regenerating-llmtxt-after-each-job)

By default, llm.txt is regenerated at the end of every static publish queue job (generate, delete, full build). To disable this and regenerate only via the build task or your own schedule, set in your YAML:

```
TomStGeorge\LLMMarkdown\Publisher\LLMMarkdownPublisher:
  regenerate_llm_txt_after_job: false
```

Optional: if you need to run the RegenerateLLMTxt task from code (e.g. after a full build job), get the publisher and call `regenerateLLMTxt()`:

```
use SilverStripe\StaticPublishQueue\Publisher;

$publisher = Publisher::singleton();
if ($publisher instanceof \TomStGeorge\LLMMarkdown\Publisher\LLMMarkdownPublisher) {
    $publisher->regenerateLLMTxt();
}
```

Documentation
-------------

[](#documentation)

- [Documentation](docs/en/README.md)

License
-------

[](#license)

BSD-3-Clause (see [LICENSE](LICENSE)).

###  Health Score

36

—

LowBetter than 79% of packages

Maintenance86

Actively maintained with recent releases

Popularity9

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity37

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

73d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/e83c57fcca6c06164df04fda36580d6364b9f6099e4af9a59c50aed3f8e73afe?d=identicon)[tomstgeorge](/maintainers/tomstgeorge)

---

Top Contributors

[![tomstgeorge](https://avatars.githubusercontent.com/u/2531109?v=4)](https://github.com/tomstgeorge "tomstgeorge (1 commits)")

---

Tags

aisilverstripemarkdownstaticcmsllm

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/tomstgeorge-silverstripe-llm-markdown/health.svg)

```
[![Health](https://phpackages.com/badges/tomstgeorge-silverstripe-llm-markdown/health.svg)](https://phpackages.com/packages/tomstgeorge-silverstripe-llm-markdown)
```

###  Alternatives

[silverstripe/cms

The SilverStripe Content Management System

5253.6M1.4k](/packages/silverstripe-cms)[silverstripe/userforms

UserForms enables CMS users to create dynamic forms via a drag and drop interface and without getting involved in any PHP code

1371.1M85](/packages/silverstripe-userforms)[spatie/laravel-markdown-response

Serve markdown versions of your HTML pages to AI agents and bots

7655.9k6](/packages/spatie-laravel-markdown-response)[symbiote/silverstripe-advancedworkflow

Adds configurable workflow support to the CMS, with a GUI for creating custom workflow definitions.

46302.4k9](/packages/symbiote-silverstripe-advancedworkflow)[undefinedoffset/silverstripe-markdown

Adds a field and a data type that allows for Markdown editing, uses the github api to render the html

126.5k1](/packages/undefinedoffset-silverstripe-markdown)[silverstripers/markdown

Markdown DB field and form field for SilverStripe

112.5k](/packages/silverstripers-markdown)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)