Skip to content

Commit

Permalink
Added readme recommendations for pre-commit
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanpeach committed Dec 17, 2024
1 parent c0b8030 commit 6836631
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,20 @@ Uses git [pre-commit](https://pre-commit.com/) to integrate with your git workfl
- id: mdlinker
```
> **_NOTE:_** Linking works best when you spell things correctly, in both your filenames and file contents. Consider pairing this tool with a spell checker.
Linking works best when you spell things correctly, in both your filenames and file contents. Also this tool only works with ASCII characters at the moment (see https://github.com/ryanpeach/mdlinker/issues/45). I recommend adding the following pre-commit hooks before this one:
```yaml
- repo: https://github.com/crate-ci/typos
rev: v1.23.7
hooks:
- id: typos
- repo: https://github.com/sirosen/texthooks
rev: 0.6.8
hooks:
- id: fix-smartquotes
- id: fix-ligatures
- id: fix-spaces
```
# Configuration
Expand Down

0 comments on commit 6836631

Please sign in to comment.