docs: add spell check capabilities to Vale linter

apify · Dec 11, 2024 · 241d10f · 241d10f
1 parent ab714d0
commit 241d10f
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 4 deletions.
diff --git a/.github/styles/config/vocabularies/Docs/accept.txt b/.github/styles/config/vocabularies/Docs/accept.txt
@@ -6,4 +6,16 @@ env
 navbar
 nginx
 npm
-
+:::caution
+:::note
+:::info
+:::tip
+:::warning
+Apify
+serverless
+SDK(s)
+[Ss]torages
+exploitability
+Whitepaper
+[Cc]ron
+Crawlee
diff --git a/vale.ini b/vale.ini
@@ -1,16 +1,19 @@
 StylesPath = .github/styles
 MinAlertLevel = warning
 IgnoredScopes = code, tt, table, tr, td
-
-vocabularies = Docs
+Vocab = docs
 
 Packages = write-good, Microsoft
 
 [formats]
 mdx = md
 
 [*.md]
-BasedOnStyles = Apify, write-good, Microsoft
+BasedOnStyles = Vale, Apify, write-good, Microsoft
+# Ignore URLs, HTML/XML tags starting with capital letter, lines containing = sign, http & https URL ending with ] or ) & email addresses
+TokenIgnores = (<\/?[A-Z].+>), ([^\n]+=[^\n]*), (http[^\n]+\)), (https[^\n]+\)), ([^\n]+@[^\n]+\.[^\n]), (http[^\n]+\]), (https[^\n]+\])
+Vale.Spelling = YES
+
 
 # Disabling rules (NO)
 Microsoft.Contractions = NO