A spell checker plugin for MkDocs.
Project description
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
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.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 292d3e726d05db626524010eff99d72908f4153eb768576bceddf1c8cc639c86 |
|
MD5 | 78960fbbd0817ae71c6b72187137a2c9 |
|
BLAKE2b-256 | b1c130a9330ea1f9cfb7e839560bc51d7d0e097c6cac1ff6c0017099c897e721 |