Skip to main content

validate

Overview

Validate markdown documents against naming, YAML frontmatter, and markdown formatting rules. Supports folder scanning, tag filtering, auto-fix with preview, conflict detection, and multiple output formats. Five validators run on each document: YAML, Naming, Markdown, Brand Voice, and Content Rules.

Usage

python main.py validate [OPTIONS]

Options

OptionDescriptionDefault
--pathValidate specific folderConfig default or .
--fileValidate specific file(s); repeatable--
--tagsFilter by tag (comma-separated)--
--forceIgnore cache and revalidate allfalse
--auto-fixAutomatically fix issues where possiblefalse
--previewPreview auto-fixes without applyingfalse
--conflictsRun conflict detection onlyfalse
--formatOutput format: console, markdown, jsonconsole
--outputOutput file for reportstdout
--min-severityMinimum severity: ERROR, WARNING, INFOConfig or INFO

Prerequisites

Examples

Validate all documents

python main.py validate

Validate a specific folder

python main.py validate --path operations/

Auto-fix with preview

python main.py validate --auto-fix --preview

Generate markdown report

python main.py validate --format markdown --output report.md