mirror of
https://github.com/j178/prek.git
synced 2026-04-25 02:11:36 +02:00
Jo
38 lines
1.1 KiB
Markdown
38 lines
1.1 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 -->"
|
|
%}
|
|
|
|
!!! warning "Not production-ready yet"
|
|
prek is not production-ready yet. Some subcommands and languages are not implemented. See the current gaps for drop-in parity on the [TODO page](./todo.md).
|
|
|
|
But it's already being adopted by [some projects](#who-is-using-prek) like Airflow, please give it a try - we'd love your feedback!
|
|
|
|
{%
|
|
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
|