Skip to content

Latest commit

 

History

History
34 lines (24 loc) · 622 Bytes

README.md

File metadata and controls

34 lines (24 loc) · 622 Bytes
Raw

MDX

A Vale configuration for sites using MDX:

  • Adds support for using MDX comment syntax ({/* ... */}).
  • Ignores imports and exports.
  • Ignores <Component ... /> and <Component> ... </Component>.
  • Ignores { ... }.

Getting Started

To get started, add the package to your configuration file (as shown below) and then run vale sync.

StylesPath = styles
MinAlertLevel = suggestion

Packages = MDX

[*]
# The 'Vale' is optional;
#
# Run `ls-config` to see the
# MDX configuration settings.
BasedOnStyles = Vale

Testing

$ make test