Skip to content
/ MDX Public
generated from errata-ai/Hugo

A Vale configuration for sites using MDX.

License

Notifications You must be signed in to change notification settings

errata-ai/MDX

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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