Skip to content

Commit d2ab503

Browse files
committed
docs: improve formatting and clarity for rendering
1 parent ee14124 commit d2ab503

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

docs/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -208,8 +208,7 @@ prek install --hook-type commit-msg --hook-type pre-push
208208
| commitizen | commit-msg |
209209
| commitizen-branch | pre-push |
210210

211-
> [!Note]
212-
> Replace `master` with the [latest tag](https://github.com/commitizen-tools/commitizen/tags) to avoid warnings. You can automatically update this with:
211+
> **Note**: Replace `master` with the [latest tag](https://github.com/commitizen-tools/commitizen/tags) to avoid warnings. You can automatically update this with:
213212
> ```sh
214213
> prek autoupdate
215214
> ```

docs/tutorials/auto_check.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,19 @@ There are two common methods for installing the hooks:
1414

1515
Using pre-commit hook frameworks is the recommended approach because hook installation, updates, and execution are handled automatically.
1616
Two common frameworks are:
17-
- [prek](https://prek.j178.dev) (faster)
18-
- [pre-commit](https://pre-commit.com/)
17+
18+
1. [prek](https://prek.j178.dev) (faster)
19+
2. [pre-commit](https://pre-commit.com/)
20+
1921

2022
In the steps below, we'll use `prek`.
2123

24+
2225
!!! tip "Using pre-commit framework"
2326
Replace `prek` with `pre-commit` in the steps below if you prefer that tool. The configuration format is similar.
2427

2528

29+
2630
#### Step 1: Install prek
2731

2832
```sh

0 commit comments

Comments
 (0)