{
"$defs": {
"GlobalConfig": {
"description": "Global configuration options",
"properties": {
"cache-dir": {
"description": "Directory to store cache files (default: .rumdl_cache)\nCan also be set via --cache-dir CLI flag or RUMDL_CACHE_DIR environment variable",
"type": [
"string",
"null"
]
},
"disable": {
"default": [],
"description": "Disabled rules",
"items": {
"type": "string"
},
"type": "array"
},
"enable": {
"default": [],
"description": "Enabled rules",
"items": {
"type": "string"
},
"type": "array"
},
"exclude": {
"default": [],
"description": "Files to exclude",
"items": {
"type": "string"
},
"type": "array"
},
"fixable": {
"default": [],
"description": "Rules that are allowed to be fixed when --fix is used\nIf specified, only these rules will be fixed",
"items": {
"type": "string"
},
"type": "array"
},
"flavor": {
"$ref": "#/$defs/MarkdownFlavor",
"default": "standard",
"description": "Markdown flavor/dialect to use (mkdocs, gfm, commonmark, etc.)\nWhen set, adjusts parsing and validation rules for that specific Markdown variant"
},
"force-exclude": {
"default": false,
"deprecated": true,
"description": "[DEPRECATED] Whether to enforce exclude patterns for explicitly passed paths.\nThis option is deprecated as of v0.0.156 and has no effect.\nExclude patterns are now always respected, even for explicitly provided files.\nThis prevents duplication between rumdl config and tool configs like pre-commit.",
"type": "boolean"
},
"include": {
"default": [],
"description": "Files to include",
"items": {
"type": "string"
},
"type": "array"
},
"line-length": {
"default": 80,
"description": "Global line length setting (used by MD013 and other rules if not overridden)",
"format": "uint64",
"minimum": 0,
"type": "integer"
},
"output-format": {
"description": "Output format for linting results (e.g., \"text\", \"json\", \"pylint\", etc.)",
"type": [
"string",
"null"
]
},
"respect-gitignore": {
"default": true,
"description": "Respect .gitignore files when scanning directories",
"type": "boolean"
},
"unfixable": {
"default": [],
"description": "Rules that should never be fixed, even when --fix is used\nTakes precedence over fixable",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"MarkdownFlavor": {
"description": "Markdown flavor/dialect enumeration",
"oneOf": [
{
"const": "standard",
"description": "Standard Markdown without flavor-specific adjustments",
"type": "string"
},
{
"const": "mkdocs",
"description": "MkDocs flavor with auto-reference support",
"type": "string"
},
{
"const": "mdx",
"description": "MDX flavor with JSX and ESM support (.mdx files)",
"type": "string"
},
{
"const": "quarto",
"description": "Quarto/RMarkdown flavor for scientific publishing (.qmd, .Rmd files)",
"type": "string"
}
]
},
"RuleConfig": {
"additionalProperties": true,
"description": "Represents a rule-specific configuration",
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": {
"$ref": "#/$defs/RuleConfig"
},
"description": "rumdl configuration for linting Markdown files. Rules can be configured individually using [MD###] sections with rule-specific options.",
"properties": {
"global": {
"$ref": "#/$defs/GlobalConfig",
"default": {
"disable": [],
"enable": [],
"exclude": [],
"fixable": [],
"flavor": "standard",
"force-exclude": false,
"include": [],
"line-length": 80,
"respect-gitignore": true,
"unfixable": []
},
"description": "Global configuration options"
},
"per-file-ignores": {
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
},
"default": {},
"description": "Per-file rule ignores: maps file patterns to lists of rules to ignore\nExample: { \"README.md\": [\"MD033\"], \"docs/**/*.md\": [\"MD013\"] }",
"type": "object"
}
},
"title": "Config",
"type": "object"
}