Docs
Formats
Markdown
Markdown
Learn how Vale handles Markdown content.
GitHub-Flavored Markdown support is built in. The supported extensions are .md
, .mdown
, .markdown
, and .markdn
.
By default, Vale ignores:
- Front matter: Blocks surrounded by
---
or+++
delimiters. - Indented blocks: Blocks starting with four or more spaces.
- Fenced blocks: Blocks surrounded by three or more backticks.
- Code spans: Text surrounded by backticks.
- URLs: See URL handling for more information.
Comments
Vale supports comment-based configuration in Markdown files:
Turn Vale off entirely:
markdownCopy <!-- vale off --> This text will be ignored. <!-- vale on -->
Turn off a specific rule:
markdownCopy <!-- vale Style.Redundancy = NO --> This is some text ACT test <!-- vale Style.Redundancy = YES -->
Turn off specific match(es) within a rule:
markdownCopy <!-- 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:
markdownCopy <!-- vale StyleName1 = YES --> <!-- vale StyleName2 = NO -->
Set styles (enabling them and switching off any other styles):
markdownCopy <!-- vale style = StyleName1 --> <!-- vale styles = StyleName1, StyleName2 -->
On This Page