mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
4a8f15c3dc
* docs: vale style audit fixes and rule tuning * docs: mirror vale style fixes to es/fr/zh translations * Update assistant/use.mdx * Apply suggestion from @ethanpalm * Apply suggestion from @ethanpalm * docs: use colons in custom selector lists --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
61 lines
1.4 KiB
INI
61 lines
1.4 KiB
INI
# Vale configuration for Mintlify documentation
|
|
|
|
StylesPath = .vale/styles
|
|
MinAlertLevel = suggestion
|
|
IgnoredScopes = code, tt, img, url, a, kbd
|
|
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: .+$, \
|
|
([\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]*```[\s\S]*?```$
|
|
|
|
CommentDelimiters = {/*, */}
|
|
|
|
[changelog.mdx]
|
|
BasedOnStyles = ""
|
|
|
|
# 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
|
|
|
|
[**/es/**]
|
|
BasedOnStyles = ""
|
|
|
|
[**/fr/**]
|
|
BasedOnStyles = ""
|
|
|
|
[**/zh/**]
|
|
BasedOnStyles = "" |