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
# 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.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 683b020c267e0b87557eb630cdb26b809859ecccd7a2e47131ad857f427e280a |
|
MD5 | 6319b9c9229bfd7c0a44306a3b79a5d5 |
|
BLAKE2b-256 | 9da995244c0bc121465eeb6d83795c2d14f6e004da7e91ca7f090ce340b692dc |