Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Aspell Processor

Purpose

Checks spelling in Markdown files using aspell.

How It Works

Discovers .md files in the project and runs aspell on each file using the configured aspell configuration file. A non-zero exit code fails the product.

Source Files

  • Input: **/*.md
  • Output: none (checker)

Configuration

[processor.aspell]
aspell = "aspell"                      # The aspell command to run
conf_dir = "."                         # Configuration directory
conf = ".aspell.conf"                  # Aspell configuration file
args = []                              # Additional arguments to pass to aspell
extra_inputs = []                      # Additional files that trigger rebuilds when changed
KeyTypeDefaultDescription
aspellstring"aspell"The aspell executable to run
conf_dirstring"."Directory containing the aspell configuration
confstring".aspell.conf"Aspell configuration file
argsstring[][]Extra arguments passed to aspell
extra_inputsstring[][]Extra files whose changes trigger rebuilds