Skip to content

Commit e12afc1

Browse files
committed
📝 Add links to linters
1 parent dd30d55 commit e12afc1

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

docs/configuration.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,12 @@ The CLI can be set up using JSON or YAML files. These files allow you to specify
4747
4848
The following examples are presented in JSON.
4949

50+
> [!IMPORTANT]
51+
> Check your work! If you are getting errors reading your config file, *don't rely on your eyes,* **use a linter!**
52+
>
53+
> - JSON: <https://jsonlint.com/>
54+
> - YAML: <https://www.yamllint.com/>
55+
5056
### Basic configuration example
5157

5258
Below is a straightforward `config.json` file. In this format, settings are noted in a `"key": "value"` structure.

0 commit comments

Comments
 (0)