Skip to content

Commit d314ce6

Browse files
committed
update doc
1 parent 1b097d9 commit d314ce6

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,14 @@ Navigate to Settings > Environments > github-pages > 🗑️
142142
### Automatic Typo Checking
143143

144144
This project uses Husky to automatically check for typos during commits. The check is performed using the `typos` tool and only runs on staged files (files that have been `git add`ed).
145+
If you want to ignore specific typos as a dictionary, please add the original and corrected versions to `_typos.toml`. ([doc](https://github.com/crate-ci/typos/tree/master?tab=readme-ov-file#false-positives))
146+
147+
148+
```bash
149+
[default.extend-words]
150+
# Don't correct the surname "Teh"
151+
teh = "teh"
152+
```
145153

146154
### Manual Typo Checking
147155

_typos.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[default.extend-words]
2+
# Don't correct the surname "Teh"
3+
teh = "teh"

0 commit comments

Comments
 (0)