Skip to content

fix(eql-docs): strip Doxygen <tt> tags so a stray one can't break the build #58

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
coderdan merged 1 commit into from
Jul 9, 2026
Merged

fix(eql-docs): strip Doxygen <tt> tags so a stray one can't break the build #58

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
6 changes: 6 additions & 0 deletions scripts/generate-eql-docs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,12 @@ function escapeMdxSpecials(content: string): string {
return part
.replace(/\{/g, "\\{")
.replace(/\}/g, "\\}")
// Strip Doxygen's `<tt>` teletype tags. They're a lowercase-led
// "tag" so the `<` rule below leaves them intact, but MDX requires
// every tag to be balanced — and mangled SQL-comment source can
// emit a stray, unclosed `<tt>` (e.g. eql-3.0.0-alpha.3's API.md),
// which fails the whole build. MDX doesn't need the tag, so drop it.
.replace(/<\/?tt\b[^>]*>/gi, "")
// Escape `<` unless it begins a real JSX/HTML tag, a closing
// tag, or an autolink (followed by a lowercase letter, `_`, `$`,
// or `/`). Uppercase-led tokens like `<T>` are type placeholders
Expand Down