Installing Vale

Install the Vale linter to begin reviewing content for style and structure.

If you are working in an established project that has already implemented Vale, you do not need to create a new vale.ini. The project will already have a vale.ini configuration.
Prerequisites

  • Install the Asciidoctor Ruby gem.

  • If you have previously installed Vale, you can check what version you are currently running. Run the following command:

    $ vale --version
    Example output
    vale version 3.6.1
Procedure

  1. Install Vale. For RHEL or Fedora Linux operating systems, run the following command:

    $ sudo dnf copr enable mczernek/vale && sudo dnf install vale

    On macOS, run:

    $ brew install vale

  2. Verify the Vale install location. You might need to update your text editor with this value.

    $ which vale
    Example output
    /usr/bin/vale

    For other operating systems, see Installing Vale.
Additional resources