Add llms.txt generation for LLM-friendly documentation#1553
Merged
j178 merged 4 commits intoj178:masterfrom Feb 4, 2026
Merged
Add llms.txt generation for LLM-friendly documentation#1553j178 merged 4 commits intoj178:masterfrom
j178 merged 4 commits intoj178:masterfrom
Conversation
Add llmstxt-standalone for generating LLM-friendly documentation files.
Configure llmstxt plugin in mkdocs.yml with section structure matching the nav. Add docs-preview, docs-build, and docs-compile mise tasks.
Run llmstxt-standalone after zensical build to generate llms.txt and llms-full.txt. Pin Python version for reproducible dependency resolution.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1553 +/- ##
==========================================
- Coverage 91.56% 91.56% -0.01%
==========================================
Files 91 91
Lines 17875 17875
==========================================
- Hits 16368 16367 -1
- Misses 1507 1508 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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
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.
Closes #1498
Generates
llms.txtandllms-full.txtfor the documentation site. Also generates markdown files at each path (e.g.,/configuration/index.md), enabling LLMs to fetch raw markdown instead of HTML.As mentioned in the issue, this wasn't natively possible, since Zensical doesn't yet support MkDocs's plugin ecosystem. I built llmstxt-standalone to work as a standalone
llms.txtgenerator, respecting the config for mkdocs-llmstxt.docs-buildanddocs-compilemise tasksNote: the generated files are not served or visible when using
zensical serve, but will be generated and published to docs site as part of thepublish-docsworkflow.Preview: