MDX

Learn how Vale handles MDX content.

MDX is supported through the external program mdx2vast. To get started, you’ll need to install the CLI:

$ npm install -g mdx2vast

You’ll need to ensure that the mdx2vast executable is available in your $PATH (this should happen automatically).

The supported extension is .mdx.

By default, Vale ignores:

• Fenced blocks: Blocks surrounded by three or more backticks.

• Code spans: Text surrounded by backticks.

• URLs: See URL handling for more information.

• JSX expressions and components.

• ESM imports and exports.

Comments

Vale supports comment-based configuration in MDX files:

• Turn Vale off entirely:

{/* vale off */}

This text will be ignored.

{/* vale on */}

• Turn off a specific rule:

{/* vale Style.Redundancy = NO */}

This is some text ACT test

{/* vale Style.Redundancy = YES */}

• Turn off specific match(es) within a rule:

{/* vale Style.Redundancy["ACT test","OTHER"] = NO */}

This is some text ACT test

{/* vale Style.Redundancy["ACT test","OTHER"] = YES */}

• Turn on or off specific styles:

{/* vale StyleName1 = YES */}

{/* vale StyleName2 = NO */}

• Set styles (enabling them and switching off any other styles):

{/* vale style = StyleName1 */}
{/* vale styles = StyleName1, StyleName2 */}

AsciiDoc HTML