markdownlint/schema/ValidatingConfiguration.md

32 lines
1.2 KiB
Markdown
Raw Normal View History

# Validating Configuration
A [JSON Schema][json-schema] is provided to enable validating configuration
objects: [`markdownlint-config-schema.json`][markdownlint-config-schema].
Some editors automatically use a JSON Schema with files that reference it. For
example, a `.markdownlint.json` file with:
```json
"$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint/main/schema/markdownlint-config-schema.json"
```
A JSON Schema validator can be used to check configuration files like so:
```bash
npx ajv-cli validate -s ./markdownlint/schema/markdownlint-config-schema.json -d "**/.markdownlint.{json,yaml}" --strict=false
```
By default, any rule name is valid because of custom rules. To allow only
built-in rules, use the
[`markdownlint-config-schema-strict.json`][markdownlint-config-schema-strict]
2026-02-06 18:15:26 -05:00
schema instead.
To allow trailing commas in a JSONC file, use the
[`markdownlint-config-schema-jsonc.json`][markdownlint-config-schema-jsonc]
schema instead. (This is based on the strict schema.)
[json-schema]: https://json-schema.org
[markdownlint-config-schema]: markdownlint-config-schema.json
[markdownlint-config-schema-strict]: markdownlint-config-schema-strict.json
2026-02-06 18:15:26 -05:00
[markdownlint-config-schema-jsonc]: markdownlint-config-schema-jsonc.json