codat-docs/.vale.ini at main · codatio/codat-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
StylesPath = .vale/styles
MinAlertLevel = suggestion

Vocab = Codat

Packages = Google

# Global ignores - skip frontmatter
[formats]
mdx = md

# File patterns
[*.{md,mdx}]
BasedOnStyles = Vale, Google

# Disable rules that conflict with technical docs or MDX
# Acronyms - too noisy for API docs
Google.Acronyms = NO
# Allow "we" in company documentation
Google.We = NO
# Spacing rule has false positives with MDX components
Google.Spacing = NO
# Semicolons in code references cause false positives
Google.Semicolons = suggestion

# Demote some rules to suggestions rather than warnings
Google.Headings = suggestion
Google.Parens = suggestion
Google.Passive = suggestion
Google.Will = suggestion
Google.FirstPerson = suggestion
Google.Exclamation = suggestion
Google.Colons = suggestion
Google.Quotes = suggestion

# Vale built-in rules
Vale.Spelling = NO
Vale.Terms = YES

# Ignore code blocks, frontmatter, and JSX
BlockIgnores = (?s) *```.*?```, (?s)^---.*?---
TokenIgnores = (`[^`]+`), (\{[^}]+\}), (<[A-Z][^>]*>.*?</[A-Z][^>]*>), (<[A-Z][^/>]*/?>)

[*.yml]
BasedOnStyles =

[*.json]
BasedOnStyles =