A spell checker plugin for MkDocs.
Project description
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
# 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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for mkdocs_spellcheck-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0bb670b1b4aa37d1b8c9289ff8891e2a91aa747a51c34b1d79d1d372dbe522d |
|
MD5 | cb72b0643231c52874f94435648623b0 |
|
BLAKE2b-256 | 0d88d2cb4b66e06130d599e22a7aa8496cbe65db09c034d762164304fa106473 |