docs/.vale.ini at 533a6477dcfd091cbf3ffb3ae2812f6e48b30d8a · mintlify/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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# Vale configuration for Mintlify documentation

StylesPath = .vale/styles
MinAlertLevel = suggestion
IgnoredScopes = code, code, tt, img, url, a
SkippedScopes = script, style, pre, figure, code

Vocab = Mintlify

# This is required since Vale doesn't officially support MDX
[formats]
mdx = md

# MDX support
[*.mdx]
BasedOnStyles = Vale, Mintlify

# Token and block ignores for MDX-specific syntax
TokenIgnores = (?m)((?:import|export) .+?$), \
(?<!`)(<\w+ ?.+ ?\/>)(?!`), \
(<[A-Z]\w+>.+?<\/[A-Z]\w+>), \
(<[^>]*>), \
\{(?!/\*)(?!/\*)[^}]*\}, \
(`[^`]*`), \, \
(?m)^openapi: .+$, \(?m)^openapi: .+$, \
([\w-]+\.)+(?:json|jsonl|png|jpe?g|gif|svg|mdx?|txt|ya?ml|xml|com|dev|io|ts|js|tsx|jsx), \
[\w-]+="[^"\n]*", \
[\w.+-]+@[\w.-]+, \
\(/[^)\s]*\)

([\w-]+\.)+(?:json|jsonl|png|jpe?g|gif|svg|mdx?|txt|ya?ml|xml|com|dev|io|ts|js|tsx|jsx), \
[\w-]+="[^"\n]*", \
[\w.+-]+@[\w.-]+, \
\(/[^)\s]*\)

BlockIgnores = (?sm)^(<\w+\n .*\s\/>)$, \
(?sm)^({(?!/\*)(?!/\*).+??})$, \
(?sm)^[ \t]*[ \t]*```[\s\S]*?```$

CommentDelimiters = {/*, */}

[changelog.mdx]
BasedOnStyles = ""

# Code-generator snippet with no prose content
# Code-generator snippet with no prose content
[snippets/vercel-json-generator.mdx]
BasedOnStyles = ""

# Component docs use dotted JSX names (Color.Row, Tree.Folder) that
# false-positive the sentence-spacing rule
[components/{color,tree}.mdx]
Mintlify.Spacing = NO

# Vale lints /api-playground/... link targets in these files in a pass
# that ignores in-document toggles
[{api-playground/asyncapi-setup.mdx,organize/settings-reference.mdx}]
Vale.Terms = NO

[snippets/vercel-json-generator.mdx]
BasedOnStyles = ""

# Component docs use dotted JSX names (Color.Row, Tree.Folder) that
# false-positive the sentence-spacing rule
[components/{color,tree}.mdx]
Mintlify.Spacing = NO

# Vale lints /api-playground/... link targets in these files in a pass
# that ignores in-document toggles
[{api-playground/asyncapi-setup.mdx,organize/settings-reference.mdx}]
Vale.Terms = NO

[**/es/**]
BasedOnStyles = ""

[**/fr/**]
BasedOnStyles = ""

[**/zh/**]
BasedOnStyles = ""