Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add spell check capabilities to Vale linter #1345

Merged
merged 13 commits into from
Jan 13, 2025
Merged

docs: add spell check capabilities to Vale linter #1345

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
241d10f
docs: add spell check capabilities to Vale linter
TC-MO Dec 11, 2024
3f46190
change vale.ini to recommended naming
TC-MO Dec 12, 2024
d619faf
Merge branch 'master' into add-vale-spelling
TC-MO Dec 12, 2024
f6c3334
remove typos workflow & config file
TC-MO Dec 12, 2024
fd07265
test new vale setup
TC-MO Dec 12, 2024
4a9e1cf
revert action branch change & name change for config file
TC-MO Dec 12, 2024
846472a
rename config file again
TC-MO Dec 12, 2024
693055c
move vocab lower
TC-MO Dec 12, 2024
349cc3b
add config flag
TC-MO Dec 12, 2024
d705616
test config flag
TC-MO Dec 12, 2024
003de23
remove config flag & rename vocab directory
TC-MO Dec 12, 2024
ca4fae2
extend vocabulary & remove unnecessary vale off and on
TC-MO Dec 13, 2024
22c04a6
fix vale & mdlint issues
TC-MO Dec 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion .github/styles/config/vocabularies/Docs/accept.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,16 @@ env
navbar
nginx
npm

:::caution
:::note
:::info
:::tip
:::warning
Apify
serverless
SDK(s)
[Ss]torages
exploitability
Whitepaper
[Cc]ron
Crawlee
9 changes: 6 additions & 3 deletions vale.ini → .vale.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Loading