Skip to main content
View as Markdown

Publish llms.txt

llms.txt is a convention for serving documentation to AI assistants as plain text at well-known URLs. When your app publishes markdown content, Sovrium can expose it that way with no work from you.

Two routes are served:

Route Contents
/llms.txt A compact index — the site title, a one-line description, and links to pages.
/llms-full.txt The same index plus every page's full markdown body, concatenated.

Both are derived from your content-directory pages, so a documentation site gets them automatically.

Configuration

The whole llms block is optional. Declare it only to turn the feature off or to override what the generated header says:

llms:
  title: Acme Handbook
  description: Everything the team needs to know.
  full: true
Property Description
enabled Serve the routes. Defaults to true when the app has content pages; false makes both 404.
title The H1 at the top of /llms.txt. Defaults to the app name.
description The blockquote under the H1. Defaults to the app description, when set.
full Serve /llms-full.txt. Defaults to true when the feature is enabled.

Turning full off is the usual adjustment for a large corpus — the index stays useful while the concatenated body, which can run to thousands of lines, is not served.

llms:
  full: false

Verify

curl -fsS http://localhost:3000/llms.txt | head -20

Every content page you expect should appear as a link. A page missing from the index is a page outside a content directory.

  • LLM Reference — Sovrium's own llms.txt, for AI tools that write configs.
  • Pages Overview — the content-directory pages the index is built from.
  • SEO & Metadata — the human-facing half of the same discoverability question.
  • App Metadata — the app name and description used as defaults.

Last updated July 27, 2026

This documentation was written with AI, so errors or outdated content are possible. Sovrium is in beta — contributions and corrections are welcome.

Built with Sovrium