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>
141 lines
3.7 KiB
YAML
141 lines
3.7 KiB
YAML
site_name: prek
|
|
site_description: Better `pre-commit` alternative, re-engineered in Rust
|
|
site_author: j178
|
|
site_url: https://prek.j178.dev/
|
|
|
|
repo_name: j178/prek
|
|
repo_url: https://github.com/j178/prek
|
|
|
|
copyright: Copyright © 2025 j178
|
|
|
|
theme:
|
|
name: material
|
|
logo: assets/logo.webp
|
|
favicon: assets/favicon.ico
|
|
palette:
|
|
- media: "(prefers-color-scheme)"
|
|
toggle:
|
|
icon: material/brightness-auto
|
|
name: Switch to light mode
|
|
- media: "(prefers-color-scheme: light)"
|
|
scheme: default
|
|
primary: indigo
|
|
accent: blue
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: slate
|
|
primary: indigo
|
|
accent: blue
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Switch to system preference
|
|
features:
|
|
- navigation.side
|
|
- navigation.sections
|
|
- navigation.expand
|
|
- navigation.path
|
|
- navigation.indexes
|
|
- navigation.instant
|
|
- navigation.instant.prefetch
|
|
- navigation.instant.progress
|
|
- navigation.tracking
|
|
- navigation.footer
|
|
- navigation.top
|
|
- content.code.copy
|
|
- content.code.annotate
|
|
- content.tabs.link
|
|
- search.suggest
|
|
- search.highlight
|
|
- search.share
|
|
|
|
plugins:
|
|
- search
|
|
- minify:
|
|
minify_html: true
|
|
- include-markdown
|
|
- llmstxt:
|
|
markdown_description: |
|
|
prek is a drop-in replacement for pre-commit, fully compatible with existing
|
|
`.pre-commit-config.yaml` files. It runs the same hooks faster, with better
|
|
toolchain management.
|
|
|
|
Key differences from pre-commit:
|
|
- Single binary, no Python runtime required
|
|
- Parallel hook execution by priority
|
|
- Built-in workspace/monorepo support
|
|
- Automatic toolchain installation (Python, Node, Go, Rust, Ruby)
|
|
- Integration with uv for Python environments
|
|
|
|
When fetching documentation, use explicit `index.md` paths for directories, e.g.,
|
|
`https://prek.j178.dev/configuration/index.md`. This returns clean markdown
|
|
instead of rendered HTML.
|
|
full_output: llms-full.txt
|
|
sections:
|
|
Getting Started:
|
|
- index.md
|
|
- installation.md
|
|
- quickstart.md
|
|
Usage:
|
|
- configuration.md
|
|
- languages.md
|
|
- cli.md
|
|
- builtin.md
|
|
- workspace.md
|
|
- integrations.md
|
|
Help:
|
|
- debugging.md
|
|
- faq.md
|
|
About:
|
|
- diff.md
|
|
- benchmark.md
|
|
- changelog.md
|
|
|
|
nav:
|
|
- Getting Started:
|
|
- Introduction: index.md
|
|
- Installation: installation.md
|
|
- Quickstart: quickstart.md
|
|
- Usage:
|
|
- Configuration: configuration.md
|
|
- Language Support: languages.md
|
|
- Commands: cli.md
|
|
- Built-in Hooks: builtin.md
|
|
- Workspace Mode: workspace.md
|
|
- Integrations: integrations.md
|
|
- Help:
|
|
- Debugging: debugging.md
|
|
- FAQ: faq.md
|
|
- About:
|
|
- Differences: diff.md
|
|
- Benchmark: benchmark.md
|
|
- Changelog: changelog.md
|
|
|
|
markdown_extensions:
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
line_spans: __span
|
|
pygments_lang_class: true
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.snippets
|
|
- pymdownx.superfences
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
combine_header_slug: true
|
|
slugify: !!python/object/apply:pymdownx.slugs.slugify
|
|
kwds:
|
|
case: lower
|
|
- pymdownx.details
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
- admonition
|
|
- attr_list
|
|
- footnotes
|
|
- md_in_html
|
|
- meta
|
|
- tables
|
|
- toc:
|
|
permalink: true
|