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
With pip
:
pip install mkdocs-spellcheck
With pipx
:
python3.7 -m pip install --user pipx
pipx install mkdocs-spellcheck
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.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2b11bebfbcd48ea7c3e392d2faed0d0d59eb09a34286c08b831a5f864785bbe2 |
|
MD5 | 1aefa810c5a9f819d09318bdff327dbf |
|
BLAKE2b-256 | fd546b900212b2b980c59b03e06bf96db0772f729e0c49e4cf7d3e8178831bd3 |