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

Support MDX as a separate language from Markdown #841

Open
1 task done
bates64 opened this issue May 28, 2024 · 1 comment
Open
1 task done

Support MDX as a separate language from Markdown #841

bates64 opened this issue May 28, 2024 · 1 comment

Comments

@bates64
Copy link

bates64 commented May 28, 2024

Check for existing issues

  • Completed

Describe the feature

Currently, people using Vale on MDX files tell Vale that it's just Markdown.

[formats]
mdx = md

But it isn't! MDX has clear differences from Markdown:

  • Comments are different Support custom comment patterns (e.g., MDX) #762
  • Vale must ignore lines that are actually JavaScript, i.e. those starting with import
  • Vale must ignore JSX expressions e.g. {1 +1}
  • Vale must not treat HTML as prose, i.e. <div foo="bar"> should not generate warnings (applies to Markdown also)
    Syntax reference
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants