Using Vale

What is Vale?

Vale is an open-source tool for linting content from a variety of different file types, including Markdown.

Using Vale with MDX

Once installed, you can use Vale with MDX files by adding a .vale.ini file to your Fern repo.

Be sure to add

[formats]
mdx = md

to your .vale.ini configuration so the MDX format is recognized.

To use Vale’s HTML-style comments () in an MDX file, wrap within an MDX-styled comment ({/* comment */}). For example:

disable Vale: {/*  */}
enable Vale: {/*  */}

Example Vale Usage

1 Vale will check this text.
2 
3 {/* <!-- vale off --> */}
4 
5 Vale won't check this text.
6 
7 {/* <!-- vale on --> */}
8 
9 Vale will start checking this text again.

1	Vale will check this text.
2
3	{/* <!-- vale off --> */}
4
5	Vale won't check this text.
6
7	{/* <!-- vale on --> */}
8
9	Vale will start checking this text again.