mirror of
https://github.com/j178/prek.git
synced 2026-04-25 02:11:36 +02:00
Jo
46 lines
1.6 KiB
Markdown
46 lines
1.6 KiB
Markdown
# prek
|
|
|
|
<div align="center">
|
|
<img width="220" alt="prek" src="/assets/logo.webp" />
|
|
</div>
|
|
|
|
--8<-- "README.md:description"
|
|
|
|
!!! note
|
|
|
|
Although prek is pretty new, it's already powering real‑world projects like [CPython](https://github.com/python/cpython), [Apache Airflow](https://github.com/apache/airflow), [FastAPI](https://github.com/fastapi/fastapi), 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 languages are not yet supported for full drop‑in parity with `pre-commit`. See [Language Support](https://prek.j178.dev/languages/) for current status.
|
|
|
|
--8<-- "README.md:features"
|
|
|
|
--8<-- "README.md:why"
|
|
|
|
## Badges
|
|
|
|
Show that your project uses prek with a badge in your README:
|
|
|
|
[](https://github.com/j178/prek)
|
|
|
|
=== "Markdown"
|
|
|
|
```markdown
|
|
[](https://github.com/j178/prek)
|
|
```
|
|
|
|
=== "HTML"
|
|
|
|
```html
|
|
<a href="https://github.com/j178/prek">
|
|
<img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/j178/prek/master/docs/assets/badge-v0.json" alt="prek">
|
|
</a>
|
|
```
|
|
|
|
=== "reStructuredText (RST)"
|
|
|
|
```rst
|
|
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/j178/prek/master/docs/assets/badge-v0.json
|
|
:target: https://github.com/j178/prek
|
|
:alt: prek
|
|
```
|