caveman-docs/.vale.ini at main · sharonwang554/caveman-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
StylesPath = styles
MinAlertLevel = error

Packages = Google, proselint

Vocab = Acme
IgnoredScopes = code, tt, img, url, a, pre
IgnoredClasses = className
# Note: we ignore the docs/api folder via glob in the command line or by removing it from the CLI run, but to do it here we can't easily exclude a folder in standard .vale.ini without specific config. Actually we can use skip for specific files, but the easiest is just not linting auto-generated files.

[formats]
mdx = md

[*.{md,mdx}]
BasedOnStyles = Vale, proselint, Acme, Google
Vale.Spelling = NO
Google.EmDash = NO
Google.Quotes = NO
Google.Latin = NO
Google.Slang = NO
Vale.Terms = NO
Google.Units = NO
proselint.Typography = NO
Google.OptionalPlurals = NO
Google.Exclamation = NO

# Custom Acme rules
Acme.Branding = YES

[**/api/**.{md,mdx}]
BasedOnStyles =
Acme.Branding = NO

[README.md]
BasedOnStyles =

[LICENSE]
BasedOnStyles =

[.agents/**]
BasedOnStyles =

[AGENTS.md]
BasedOnStyles =

[styles/**]
BasedOnStyles =