Skip to content

Commit

Permalink
docs: Update README links
Browse files Browse the repository at this point in the history
Signed-off-by: Valentin Kiselev <[email protected]>
  • Loading branch information
mrexox committed Nov 28, 2022
1 parent a6fc69c commit 48c8666
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,15 +57,15 @@ See:
## Why Lefthook

* ### **Parallel execution**
Gives you more speed. [Example](./docs/full_guide.md#parallel-execution)
Gives you more speed. [Example](./docs/configuration.md#parallel)

```yml
pre-push:
parallel: true
```

* ### **Flexible list of files**
If you want your own list. [Custom](./docs/full_guide.md#custom-file-list) and [prebuilt](./docs/full_guide.md#select-specific-file-groups) examples.
If you want your own list. [Custom](./docs/configuration.md#files) and [prebuilt](./docs/configuration.md#run) examples.

```yml
pre-commit:
Expand Down Expand Up @@ -105,7 +105,7 @@ pre-commit:

* ### **Run scripts**

If oneline commands are not enough, you can execute files. [Example](./docs/full_guide.md#bash-script-example).
If oneline commands are not enough, you can execute files. [Example](./docs/configuration.md#script).

```yml
commit-msg:
Expand All @@ -115,7 +115,7 @@ commit-msg:
```

* ### **Tags**
If you want to control a group of commands. [Example](./docs/full_guide.md#skipping-commands-by-tags).
If you want to control a group of commands. [Example](./docs/configuration.md#tags).

```yml
pre-push:
Expand All @@ -130,7 +130,7 @@ pre-push:

* ### **Support Docker**

If you are in the Docker environment. [Example](./docs/full_guide.md#referencing-commands-from-lefthookyml).
If you are in the Docker environment. [Example](./docs/configuration.md#cmd-template).

```yml
pre-commit:
Expand All @@ -141,7 +141,7 @@ pre-commit:

* ### **Local config**

If you a frontend/backend developer and want to skip unnecessary commands or override something into Docker. [Description](./docs/full_guide.md#local-config).
If you a frontend/backend developer and want to skip unnecessary commands or override something into Docker. [Description](./docs/usage.md#local-config).

```yml
# lefthook-local.yml
Expand Down Expand Up @@ -178,7 +178,9 @@ $ lefthook run fixer
```

* ### **Optional output**
If you don't want to see supporting information:

If you [don't want to see](./docs/configuration.md#skip_output) supporting information:

```yml
skip_output:
- meta #(version and which hook running)
Expand Down

0 comments on commit 48c8666

Please sign in to comment.