Skip to content

Reject embedded images in connector docs MDX lint #101

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

Reject embedded images in connector docs MDX lint #101

Show file tree
Hide file tree
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: 5 additions & 1 deletion tools/mdx-lint/mdx-lint.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,8 +175,12 @@ function validateTree(tree) {
case "html":
fail(node, "contains raw HTML");
break;
case "link":
// Embedded images make the registry's MDX renderer emit a <link rel=preload>, which its HTML validator rejects.
case "image":
case "imageReference":
fail(node, "contains an embedded image; connector docs must not embed images");
break;
case "link":
case "definition":
validateUrlNode(node);
break;
Expand Down
12 changes: 12 additions & 0 deletions tools/mdx-lint/testdata/shared-mdx-validation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,5 +96,17 @@
"valid": false,
"errorContains": "dangerous URL scheme",
"content": "[link](java&#x73;cript:alert(1))\n"
},
{
"name": "reject markdown embedded image",
"valid": false,
"errorContains": "must not embed images",
"content": "![diagram](./images/diagram.png)\n"
},
{
"name": "reject markdown image reference",
"valid": false,
"errorContains": "must not embed images",
"content": "![diagram][ref]\n\n[ref]: ./images/diagram.png\n"
}
]