Configuration File

Creating a Config File

Run --init to scaffold a default config:

md-go-validator --init

This creates .md-go-validator.yaml in the current directory.

languages:
  - go
  - typescript
exclude:
  - "vendor/*"
  - "node_modules/**"
skipDirectives:
  - "<!-- sketch -->"
format: table

Field	Type	Description
`languages`	list	Languages to validate (identifiers from Supported Languages)
`exclude`	list	Glob patterns to exclude (supports `**`)
`skipDirectives`	list	Custom skip directives in addition to the built-in ones
`format`	string	Default output format

By default, md-go-validator looks for .md-go-validator.yaml in the current working directory. Use --config to specify a custom path:

md-go-validator --config /path/to/config.yaml .

CLI flags always override config file values. This lets you set defaults in the config file and override per-invocation:

# Config sets format: table, override to JSON
md-go-validator -f json .