Skip to content

Commit e571a07

Browse files
committed
chore: docs
1 parent 4a118d8 commit e571a07

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

Diff for: README.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ Yarn Berry plugin for easy Git Hooks.
44

55
## Installation
66

7-
```sh
7+
```console
88
yarn plugin import https://raw.githubusercontent.com/trufflehq/yarn-plugin-git-hooks/main/bundles/%40yarnpkg/plugin-git-hooks.js
99
```
1010

1111
## Usage
1212

1313
1. Create your Git Hooks. We recommend `.github/hooks`.
1414

15-
> **Warning**:
15+
> [!WARNING]
1616
> Make sure they are are executable (`chmod +x ./commit-msg`)!
1717
>
1818
> ```ansi
@@ -21,18 +21,16 @@ yarn plugin import https://raw.githubusercontent.com/trufflehq/yarn-plugin-git-h
2121
2222
2. Specify the path to your Git Hooks directory in `.yarnrc.yml`:
2323
24-
```yaml
24+
```yml
2525
gitHooksPath: .github/hooks
2626
```
2727
2828
Now, every time you run `yarn` (once packages are installed), your hooks will be configured.
2929

30-
> **Note**:
30+
> [!NOTE]
3131
> You can check the configuration succeeded with `git config --get core.hookspath`.
3232
33-
## Docker
34-
35-
> **Important**:
33+
> [!WARNING]
3634
> This plugin is not compatible with Docker.
3735
> To disable, set `YARN_NO_INSTALL_GITHOOKS=1`.
3836
>

0 commit comments

Comments
 (0)