mkdocs-spellcheck 0.1.1

A spell checker plugin for MkDocs.

MkDocs SpellCheck

A spell checker plugin for MkDocs.

Requirements

MkDocs SpellCheck requires Python 3.7 or above.

To install Python 3.7, I recommend using pyenv.

# install pyenv
git clone https://github.com/pyenv/pyenv ~/.pyenv

# setup pyenv (you should also put these three lines in .bashrc or similar)
export PATH="${HOME}/.pyenv/bin:${PATH}"
export PYENV_ROOT="${HOME}/.pyenv"
eval "$(pyenv init -)"

# install Python 3.7
pyenv install 3.7.12

# make it available globally
pyenv global system 3.7.12

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

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