Skip to content

Commit

Permalink
Fix vocab paths for 3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jdkato committed Jan 11, 2024
1 parent a1655c3 commit 0c584dc
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions content/en/docs/topics/vocab/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,18 @@ without having to re-implement them.

## Folder structure

`Vocab` entries are stored in `<StylesPath>/Vocab/<name>/` and are then
referenced by `<name>` in `.vale.ini`. For example, consider the following
folder structure:
{{< alert context="info">}}
**Heads up**!

In versions of Vale prior to 3.0, vocabularies were stored in the
`<StylesPath>/Vocab` folder. If you're upgrading from an older version of Vale,
you'll need to move your vocabularies to the new
`<StylesPath>/config/vocabularies/` location.
{{< /alert >}}

Vocabulary entries are stored in `<StylesPath>/config/vocabularies/<name>/` and
are then referenced by `<name>` in `.vale.ini`. For example, consider the
following folder structure:

```bash
$ tree styles
Expand Down Expand Up @@ -157,9 +166,3 @@ vocabularies are for style *users*:

* As a user of styles, vocabularies should be able to replace the use of ignore
files completely.

For example, if you were using `Vale.Spelling` with a `<StylesPath>/vocab.txt`
file prior to `v2.3`, you can simply copy the contents of `vocab.txt` into
`<StylesPath>/Vocab/<MyVocab>/accept.txt` and it'll work the same (you may
also want to disable `Vale.Terms` and `Vale.Avoid` to replicate the exact
experience).

0 comments on commit 0c584dc

Please sign in to comment.