mirror of
https://github.com/j178/prek.git
synced 2026-04-25 02:11:36 +02:00
Shaan Majid
d548c08361
Closes #1498 Generates `llms.txt` and `llms-full.txt` for 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](https://github.com/shaanmajid/llmstxt-standalone) to work as a standalone `llms.txt` generator, respecting the config for [mkdocs-llmstxt](https://github.com/pawamoy/mkdocs-llmstxt). - Configure llmstxt plugin in mkdocs.yml with section structure - Add `docs-build` and `docs-compile` mise tasks - Update CI to run llmstxt-standalone after zensical build Note: the generated files are not served or visible when using `zensical serve`, but will be generated and published to docs site as part of the `publish-docs` workflow. Preview: - [llms.txt](https://gist.github.com/shaanmajid/767af572028a23ec4d0bfac2015011a5#file-llms-txt) - [llms-full.txt](https://gist.github.com/shaanmajid/767af572028a23ec4d0bfac2015011a5#file-llms-full-txt) --------- Co-authored-by: Jo <10510431+j178@users.noreply.github.com>
3 lines
43 B
Plaintext
3 lines
43 B
Plaintext
llmstxt-standalone==0.2.0
|
|
zensical==0.0.17
|