Skip to content

Commit e1e5e69

Browse files
authored
Update README.md (#127)
Add Vale whitelist configuration blurb
1 parent 1b6b1e2 commit e1e5e69

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,14 @@ Navigation (and other global settings) is defined in `mint.json`. Learn more abo
2828

2929
NB: If you move or rename a page, ensure you add a redirect (via the `redirects` property) to that existing links that were shared via Discord etc continue to work.
3030

31+
#### Whitelisting Terms
32+
33+
Certain terms can be whitelisted such that Mintlify's Vale integration does not flag them as misspelled.
34+
35+
Modify the `.github/vale/config/vocabularies/PowerSync/accept.txt` file to add terms to the whitelist - every line is a new term. Terms added to the whitelist are not case-sensitive, but capitalisation is still used for readability purposes. Further info on Vale vocab lists can be found in [Mintlify's docs](https://mintlify.com/docs/settings/ci#vale) and [Vale's docs](https://vale.sh/docs/keys/vocab).
36+
37+
NB: If you need to blacklist terms, you can create a `reject.txt` file in the same folder as `accept.txt`.
38+
3139
#### Icons
3240

3341
Only Fontawesome icons are currently supported: https://fontawesome.com/search

0 commit comments

Comments
 (0)