Skip to content

Commit

Permalink
docs: update the intro page (#938)
Browse files Browse the repository at this point in the history
  • Loading branch information
mrexox authored Jan 21, 2025
1 parent f5e7084 commit 038a0ee
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 10 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,10 @@ A Git hooks manager for Node.js, Ruby, Python and many other types of projects.
* **Powerful.** It allows to control execution and files you pass to your commands.
* **Simple.** It is single dependency-free binary which can work in any environment.

📖 [Read the introduction post](https://evilmartians.com/chronicles/lefthook-knock-your-teams-code-back-into-shape?utm_source=lefthook)

📖 [Read the documentation][documentation]
📖 [Introduction post](https://evilmartians.com/chronicles/lefthook-knock-your-teams-code-back-into-shape?utm_source=lefthook)

<a href="https://evilmartians.com/?utm_source=lefthook">
<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>
<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="100%" height="54"></a>

## Install

Expand Down
1 change: 1 addition & 0 deletions docs/mdbook/favicon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 29 additions & 6 deletions docs/mdbook/intro.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,44 @@
# Introduction

<img align="right" width="147" height="125" title="Lefthook logo"
src="./favicon.svg">

**Lefthook** is a Git hooks manager. This documentation provides the reference for installing, configuring and using the lefthook.

Maybe you are looking for

- **[Installation instructions](./installation)** to install lefthook to your system or just project.
- **[Installation instructions](./installation)** to install lefthook to your OS or project.

- **[Examples](./examples)** of lefthook common usage.

- **[Configuration](./configuration)** with details explanation of lefthook options.
- **[Configuration](./configuration)** with detailed explanation of lefthook options.


**Example:** Run your linters on `pre-commit` hook and forget about the routine.

```yml
# lefthook.yml

pre-commit:
parallel: true
jobs:
- run: yarn run stylelint --fix {staged_files}
glob: "*.css"
stage_fixed: true

- run: yarn run eslint --fix "{staged_files}"
glob:
- "*.ts"
- "*.js"
- "*.tsx"
- "*.jsx"
stage_fixed: true
```
---
<a href="https://evilmartians.com/?utm_source=lefthook">
<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="236" height="54"></a>

<img src="https://evilmartians.com/badges/sponsored-by-evil-martians.svg" alt="Sponsored by Evil Martians" width="100%" height="54"></a>
If you have a question or found a mistake in the documentation, please create a new [discussion](https://github.com/evilmartians/lefthook/discussions/new/choose). Small contributions help maintaining the quality of the project.
_If you have a question or found a mistake in the documentation, please create a new [discussion](https://github.com/evilmartians/lefthook/discussions/new/choose). Small contributions help maintaining the quality of the project._

0 comments on commit 038a0ee

Please sign in to comment.