Skip to content
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.

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

Disable MD034 / no-bare-urls #27

Merged
merged 2 commits into from
Jan 11, 2025
Merged

Disable MD034 / no-bare-urls #27

merged 2 commits into from
Jan 11, 2025

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.

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 join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants