Skip to content

Commit

Permalink
Add example for remote dictionaries (#4039)
Browse files Browse the repository at this point in the history
* Add example for remote dictionaries
* Remove copy/paste error
* Fix incorrect dictionary name

Co-authored-by: Jason Dent <Jason3S@users.noreply.github.com>
  • Loading branch information
exhuma and Jason3S authored Jan 22, 2023
1 parent 0b301f1 commit b98ee93
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions docs/configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,15 +85,20 @@ Or you can specify a path to a config file with the `--config <path>` argument o

```javascript
"language": "en",
// Dictionaries "spanish", "ruby", and "corp-term" will always be checked.
// Dictionaries "spanish", "ruby", and "corp-terms" will always be checked.
// Including "spanish" in the list of dictionaries means both Spanish and English
// words will be considered correct.
"dictionaries": ["spanish", "ruby", "corp-terms", "fonts"],
// Define each dictionary. Relative paths are relative to the config file.
// Define each dictionary:
// - Relative paths are relative to the config file.
// - URLs will be retrieved via HTTP GET
"dictionaryDefinitions": [
{ "name": "spanish", "path": "./spanish-words.txt"},
{ "name": "ruby", "path": "./ruby.txt"},
{ "name": "company-terms", "path": "./corp-terms.txt"}
{
"name": "corp-terms",
"path": "https://shared-company-repository/cspell-terms.txt"
},
],
```

Expand Down

0 comments on commit b98ee93

Please sign in to comment.