Skip to content
This repository was archived by the owner on Jul 23, 2025. It is now read-only.

Conversation

@danbarr
Copy link
Collaborator

@danbarr danbarr commented Jan 9, 2025

While we should avoid bare URLs, the fix for this rule (surrounding the URL with <>) breaks rendering, since Docusaurus currently runs all files through the MDX engine and a < is interpreted as a JSX tag.

This PR also sorts the .markdownlint.json config alphabetically by the alias names instead of by the rule ID.

@vercel
Copy link

vercel bot commented Jan 9, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
codegate-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 11, 2025 0:13am

While we should avoid bare URLs, the fix for this rule (surrounding
the URL with <>) breaks rendering, since Docusaurus currently runs all
files through the MDX engine.
(instead of rule ID)
@danbarr danbarr merged commit 9d6985d into main Jan 11, 2025
6 checks passed
@danbarr danbarr deleted the disable-md034 branch January 11, 2025 17:22
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants