hextra
hextra copied to clipboard
Lint documentation with vale
Feature Description
Vale is a syntax-aware linter for prose built with speed and extensibility in mind.
It's used by many large organizations and projects such as Grafana, Docker, Microsoft etc.
Problem/Solution
Currently there's no spell check for the documentation files under exampleSite/content.
We need to add a .vale.ini file:
StylesPath = .github/vale
MinAlertLevel = warning
Packages = Google, Hugo, write-good
Vocab = Hextra
[*.md]
BasedOnStyles = Vale, Google, write-good
SkippedScopes = script, style, pre, figure, blockquote
Google.Ellipses = NO
Google.Exclamation = suggestion
Google.Headings = NO
Google.We = suggestion
Google.Will = suggestion
Google.WordList = NO
write-good.Passive = NO
write-good.So = NO
write-good.ThereIs = NO
write-good.TooWordy = NO
write-good.Weasel = NO
write-good.E-Prime = NO
We may need to customize the rules since some of them are too opinionated.