mkdocs-spellcheck 0.2.2

A spell checker plugin for MkDocs.

MkDocs SpellCheck

A spell checker plugin for MkDocs.

Installation

pip install mkdocs-spellcheck

Usage

# mkdocs.yml
plugins:
- search
- spellcheck:
    # known_words can also be a list of words
    known_words: known_words.txt

    # ignore words in <code> tags
    ignore_code: yes

    # minimum length of words to consider
    min_length: 2

    # maximum number of capital letters in a word
    max_capital: 1

    # keep unicode characters
    allow_unicode: no

    # skip files entirely
    skip_files:
    - credits.md
    - coverage.md