Skip to content

Lint MDX pages with Vale #2544

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kcmartin merged 1 commit into from
Oct 9, 2026
Merged

Lint MDX pages with Vale #2544

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .vale.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ SkippedScopes = script

Packages = proselint, write-good, Google

[*{.markerb,md}]
[*.{md,mdx,markerb}]
BasedOnStyles = Fly, Google, proselint, Vale, write-good

# Fly rules that we can turn back on when other things get cleaned up
Expand All @@ -18,6 +18,7 @@ Fly.Latin = NO
Fly.Machine = NO # we can do an initial search and replace and then this rule will be less noisy and more useful
Fly.OxfordComma = NO
Fly.SentenceLength = NO # turn on later; then reduce further?
Fly.Spelling = NO # off until the vocabulary covers MDX pages: 369 unflagged-before terms, mostly product and tool names
Fly.Us = NO

# other style stuff turned off temporarily
Expand Down Expand Up @@ -79,3 +80,4 @@ Vale.Terms = NO # noisy false positives: enforces vocab-term casing even inside

[formats]
markerb = md # maps our markerb file extension to md for linting
mdx = md # Mintlify pages are MDX; parse them as Markdown
Loading