AsciiDoc

AsciiDoc is supported through the external program Asciidoctor. See their installation instructions to get started. You’ll need to ensure that the asciidoctor executable is available in your $PATH.

The supported extensions are .adoc, .asciidoc, and .asc.

By default, Vale ignores:

• Front matter: Blocks surrounded by --- or +++ delimiters.
• Literals and source code.
• URLs: See URL handling for more information.

Attributes

You can customize how asciidoctor is called by passing document attributes:

ini
Copy
StylesPath = styles

[asciidoctor]
# attribute = value
#
# where 'YES' enables and 'NO' disables.

# enable
experimental = YES

# assign a specific value
attribute-missing = drop

[*.adoc]
BasedOnStyles = Vale

Comments

Vale supports comment-based configuration in AsciiDoc files:

• Turn Vale off entirely:

  adoc
  Copy
  pass:[<!-- vale off -->]
  
  This text will be ignored.
  
  pass:[<!-- vale on -->]

• Turn off a specific rule:

  adoc
  Copy
  pass:[<!-- vale Style.Redundancy = NO -->]
  
  This is some text ACT test
  
  pass:[<!-- vale Style.Redundancy = YES -->]

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

  adoc
  Copy
  pass:[<!-- vale Style.Redundancy["ACT test","OTHER"] = NO -->]
  
  This is some text ACT test
  
  pass:[<!-- vale Style.Redundancy["ACT test","OTHER"] = YES -->]

• Turn on or off specific styles:

  adoc
  Copy
  pass:[<!-- vale StyleName1 = YES -->]
  pass:[<!-- vale StyleName2 = NO -->]

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

  adoc
  Copy
  pass:[<!-- vale style = StyleName1 -->]
  pass:[<!-- vale styles = StyleName1, StyleName2 -->]