Configuration
mdbook-lint can be configured through configuration files to customize its behavior for your project.
Configuration File
Create a .mdbook-lint.toml file in your project root:
# Basic settings
fail-on-warnings = false
disabled-rules = ["MD013", "MD033"]
# Rule-specific configuration
[rules.MD007]
indent = 2
[rules.MD013]
line-length = 120
Configuration Options
Global Settings
| Setting | Type | Default | Description |
|---|---|---|---|
fail-on-warnings | boolean | false | Exit with error code when warnings are found |
disabled-rules | array | [] | List of rule IDs to disable |
Rule Configuration
Individual rules can be configured in the [rules.<RULE_ID>] sections.
MD007 - Unordered list indentation
[rules.MD007]
indent = 2 # Number of spaces for list indentation
MD013 - Line length
[rules.MD013]
line-length = 80 # Maximum line length
code-blocks = false # Check line length in code blocks
tables = false # Check line length in tables
Configuration Precedence
Configuration is loaded in the following order (later sources override earlier ones):
- Built-in defaults
.mdbook-lint.tomlin project root- Command-line arguments
Examples
Strict Configuration
fail-on-warnings = true
disabled-rules = [] # Enable all rules
[rules.MD013]
line-length = 80
Relaxed Configuration
fail-on-warnings = false
disabled-rules = ["MD013", "MD033", "MD041"]
[rules.MD007]
indent = 4
mdBook-focused Configuration
# Disable rules that conflict with mdBook conventions
disabled-rules = ["MD025"] # Multiple top-level headers are OK in mdBook
fail-on-warnings = true
Next Steps
- Learn about CLI Usage
- Browse the Configuration Reference for all options
- See Rules Reference for rule-specific settings