Usage: great-docs spell-check [OPTIONS]
Check spelling in documentation files.
This command scans documentation files (.qmd, .md) for spelling errors. It
intelligently skips code blocks, inline code, URLs, and technical terms.
A built-in dictionary of common programming terms is included (e.g., "api",
"cli", "json", "yaml", "pytest", etc.). You can add custom words using
-d/--dictionary or --dictionary-file.
Examples:
great-docs spell-check # Check all docs
great-docs spell-check --verbose # Show progress
great-docs spell-check -d myterm -d anotherterm # Add custom words
great-docs spell-check --dictionary-file words.txt # Load custom dictionary
great-docs spell-check --include-docstrings # Also check Python docstrings
great-docs spell-check --json-output # Output as JSON
Options:
--project-path DIRECTORY Path to your project root directory (default:
current directory)
--docs-dir TEXT Path to documentation directory relative to
project root
--include-docstrings Also check spelling in Python docstrings
-d, --dictionary TEXT Additional word(s) to consider correct (can be
used multiple times)
--dictionary-file PATH Path to file with custom words (one per line)
-v, --verbose Show detailed progress for each file checked
--json-output Output results as JSON
--help Show this message and exit.