docs: enable LLM-friendly outputs (llms.txt + per-page markdown)#12
Merged
Conversation
Opt into the hextra >= 0.12 output formats: a /llms.txt index of the whole site and a raw-markdown twin of every page. Addresses the 'one-page LLM docs' roadmap idea. RSS is preserved on home/section outputs. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add a Tools > LLM-Friendly Docs page describing /llms.txt and the per-page .md access, and slot it into the section nav (after MCP Servers). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Tests the
llms/markdownoutput formats that shipped with the hextra v0.12.3 bump (#11). Opting in is a single[outputs]block — no new templates needed.What it produces (verified with a local Hugo 0.163.2 build):
/llms.txt— a one-page index of the entire site: title, section tree, and a one-line summary + link for every page. This is the llms.txt standard and the "one-page LLM docs" roadmap idea..mdtwin of all 35 pages (e.g./docs/peering/getting-started.md), ideal for agents/LLMs to ingest without HTML noise.Depends on #11 (the theme bump) — until that merges to
main, this PR's diff also shows the theme/Hugo-pin commit; it'll reduce to just the[outputs]change once #11 lands.Minor polish available, not included:
/llms.txt's>description line is blank because the site sets noparams.description— adding a one-line site description would populate it.🤖 Generated with Claude Code