Skip to content

Commit 241d10f

Browse files
committed
docs: add spell check capabilities to Vale linter
1 parent ab714d0 commit 241d10f

File tree

2 files changed

+19
-4
lines changed

2 files changed

+19
-4
lines changed

.github/styles/config/vocabularies/Docs/accept.txt

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,16 @@ env
66
navbar
77
nginx
88
npm
9-
9+
:::caution
10+
:::note
11+
:::info
12+
:::tip
13+
:::warning
14+
Apify
15+
serverless
16+
SDK(s)
17+
[Ss]torages
18+
exploitability
19+
Whitepaper
20+
[Cc]ron
21+
Crawlee

vale.ini

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,19 @@
11
StylesPath = .github/styles
22
MinAlertLevel = warning
33
IgnoredScopes = code, tt, table, tr, td
4-
5-
vocabularies = Docs
4+
Vocab = docs
65

76
Packages = write-good, Microsoft
87

98
[formats]
109
mdx = md
1110

1211
[*.md]
13-
BasedOnStyles = Apify, write-good, Microsoft
12+
BasedOnStyles = Vale, Apify, write-good, Microsoft
13+
# Ignore URLs, HTML/XML tags starting with capital letter, lines containing = sign, http & https URL ending with ] or ) & email addresses
14+
TokenIgnores = (<\/?[A-Z].+>), ([^\n]+=[^\n]*), (http[^\n]+\)), (https[^\n]+\)), ([^\n]+@[^\n]+\.[^\n]), (http[^\n]+\]), (https[^\n]+\])
15+
Vale.Spelling = YES
16+
1417

1518
# Disabling rules (NO)
1619
Microsoft.Contractions = NO

0 commit comments

Comments
 (0)