Skip to content

Commit

Permalink
Add VALE_CONFIG_PATH to search process docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jdkato committed Aug 28, 2023
1 parent 841e6c2 commit 14a2961
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions content/en/docs/topics/config/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -278,14 +278,15 @@ This is a steward that raises an alert.

{{< alert icon="👉" >}}
You can override the default search process by manually specifying a path using
the [--config](/manual/config/) option.
the [--config](/manual/config/) option or by defining a `VALE_CONFIG_PATH` environment variable.
{{< /alert >}}

Vale expects its configuration to be in a file named `.vale.ini` or
`_vale.ini`. It'll start looking for this file in the same folder as the file
that's being linted. If it can't find one, it'll search up to 6 levels up the
file tree. After 6 levels, it'll look for a global configuration file in the OS
equivalent of `$HOME` \(see below\).
that's being linted. If it can't find one, it'll search up up the file tree.

If no ancestor of the current directory has a configuration file, it checks for
a global configuration file in the OS equivalent of `$HOME` \(see below\).

| OS | Search Locations |
| :------ | :--------------------------------------------------- |
Expand Down

0 comments on commit 14a2961

Please sign in to comment.