@cerbos/antora-llm-generator
is an Antora extension that creates two auxiliary text files after each site build:
llms.txt
llms-full.txt
Both files combine selected site content into a single Markdown document so that large-language models can ingest concise background material, usage guidance, and deep-link references. See the specification at https://llmstxt.org/.
yarn global add @cerbos/antora-llm-generator
# or
npm install --global @cerbos/antora-llm-generator
Add the extension to your antora-playbook.yaml
:
antora:
extensions:
- require: "@cerbos/antora-llm-generator"
skippaths:
- "someGlob/**/path"
skippaths
accepts one or more glob patterns. Any file that matches a pattern is omitted from bothllm.txt
andllm-full.txt
.
You can exclude individual pages without touching the playbook by setting AsciiDoc page attributes:
:page-llms-ignore: true # omit from llms.txt
:page-llms-full-ignore: true # omit from llms-full.txt
Apply either or both attributes at the top of the source file.
Run your Antora build as usual:
antora antora-playbook.yaml
On completion, two extra files - /llms.txt
and /llms-full.txt
- appear in the build output directory alongside your generated site. Distribute or host them wherever LLMs need access.
- Purpose: supply LLM-ready summaries of your documentation site.
- Zero friction: install, update the playbook, rebuild.
- Granular control: exclude by path globs or per-page attributes.
For more details, visit https://llmstxt.org/.