Skip to main content

Configuration Reference

Zenzic reads a single .zenzic.toml file at the repository root. All fields are optional — Zenzic works out of the box with no configuration file at all.

Zero configuration

Most projects need no .zenzic.toml at all. Run uvx zenzic check all — if it passes, you're done. Only add configuration when you need to customise specific behaviour.

Reference sections

This reference is split into focused pages:

PageContents
Configuration Referencedocs_dir, exclusion lists, thresholds, scoring, build_context, adapter auto-detection
Custom Rules DSL[[custom_rules]] — project-specific regex lint rules in pure TOML
Brand SystemPalette contract, semantic tokens, and React component styling rules

Full example

The simplest complete .zenzic.toml that exercises every section:

docs_dir = "docs"
excluded_dirs = ["includes", "assets", "stylesheets", "overrides"]
excluded_assets = []
excluded_build_artifacts = []
snippet_min_lines = 1
placeholder_max_words = 50
placeholder_patterns = ["coming soon", "work in progress", "wip", "todo", "stub", "draft", "tbd", "da completare", "bozza"]
validate_same_page_anchors = false
excluded_external_urls = []
fail_under = 80

[[custom_rules]]
id = "ZZ-NODRAFT"
pattern = "(?i)\\bDRAFT\\b"
message = "Remove DRAFT marker before publishing."
severity = "warning"

[build_context]
engine = "mkdocs"
default_locale = "en"
locales = ["it"]