Skip to content

fix(ci): Vale flagging MDX custom heading-ID comments as prose #4833

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
lennessyy merged 2 commits into from
Jul 7, 2026
Merged

fix(ci): Vale flagging MDX custom heading-ID comments as prose #4833

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
866c638
Fix Vale flagging MDX custom heading-ID comments as prose
lennessyy Jul 6, 2026
3488614
Merge branch 'main' into vale-fix-mdx-heading-id
lennessyy Jul 7, 2026
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
3 changes: 3 additions & 0 deletions .vale-ci.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,8 @@ Temporal.complexwords = NO
Temporal.programming = NO
Temporal.WordList = NO

; ignore MDX custom heading-ID comments, e.g. {/* #ha-worker-patterns */}
TokenIgnores = (\{/\*[^\n]*?\*/\})

[formats]
mdx = md
2 changes: 2 additions & 0 deletions vale/test/headings-good.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,5 @@
## Update a running Workflow

## Durable External Storage for large payloads

## Highly available Worker patterns {/* #ha-worker-patterns */}
2 changes: 2 additions & 0 deletions vale/test/terms-bad.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,5 @@ Use heartbeating to report activity progress.
The codec server provides remote payload encoding.

A child workflow execution inherits the parent close policy.

## Highly available worker patterns {/* #ha-worker-patterns */}