mirror of
https://github.com/j178/prek.git
synced 2026-04-03 17:34:03 +02:00
39 lines
1.3 KiB
Markdown
39 lines
1.3 KiB
Markdown
# prek
|
|
|
|
<div align="center">
|
|
<img width="220" alt="prek" src="/assets/logo.webp" />
|
|
</div>
|
|
|
|
{%
|
|
include-markdown "../README.md"
|
|
start="<!-- description:start -->"
|
|
end="<!-- description:end -->"
|
|
%}
|
|
|
|
!!! note
|
|
|
|
Although prek is pretty new, it’s already powering real‑world projects like [Apache Airflow](https://github.com/apache/airflow), and more projects are picking it up—see [Who is using prek?](#who-is-using-prek). If you’re looking for an alternative to `pre-commit`, please give it a try—we’d love your feedback!
|
|
|
|
Please note that some subcommands and languages are still missing for full drop‑in parity with `pre-commit`. Track the remaining gaps here: [TODO](https://prek.j178.dev/todo/).
|
|
|
|
{%
|
|
include-markdown "../README.md"
|
|
start="<!-- features:start -->"
|
|
end="<!-- features:end -->"
|
|
%}
|
|
|
|
{%
|
|
include-markdown "../README.md"
|
|
start="<!-- why:start -->"
|
|
end="<!-- why:end -->"
|
|
%}
|
|
|
|
## Getting Started
|
|
|
|
- [Installation](./installation.md) - How to install prek
|
|
- [Quickstart](./quickstart.md) - Getting started with prek
|
|
- [Configuration](./configuration.md) - Configuring prek
|
|
- [Workspace Mode](./workspace.md) - Monorepo support
|
|
- [Differences](./diff.md) - What's different from pre-commit
|
|
- [Debugging](./debugging.md) - Troubleshooting tips
|