MkDocs SpellCheck
A spell checker plugin for MkDocs.
This plugin can use different backends to check the spelling of words in your final HTML pages. These backends are:
Installation
To install all backends, use the all extra. Otherwise specify the name(s) of the backend(s) as extra.
pip install 'mkdocs-spellcheck[all]'
pip install 'mkdocs-spellcheck[codespell]'
pip install 'mkdocs-spellcheck[symspellpy]'
pip install 'mkdocs-spellcheck[codespell,symspellpy]'
Usage
# mkdocs.yml
plugins:
- search
- spellcheck:
backends: # the backends you want to use
- symspellpy # as strings
- codespell: # or nested configs
dictionaries: [clear, rare]
# 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 (supports Unix shell-style wildcards)
skip_files:
- credits.md
- coverage.md
- reference/*
# whether to only check in strict mode
strict_only: yes
By default, the symspellpy backend is used.
Once your configuration is ready, just run mkdocs build -s to check the spelling inside your pages.
codespell
The builtin dictionaries are:
clearfor unambiguous errorsrarefor rare (but valid) words that are likely to be errorsinformalfor making informal words more formalusagefor replacing phrasing with recommended termscodefor words from code and/or mathematics that are likely to be typos in other contexts (such asuint)namesfor valid proper names that might be typosen-GB_to_en-USfor corrections fromen-GBtoen-US
On-off regions
In some situations it can be useful to temporarily disable spell checking for a document.
To this end, MkDocs SpellCheck recognizes special guards mkdocs-spellcheck-{on,off}:
Here MkDocs SpellCheck checks for correct spelling.
<!-- mkdocs-spellcheck-off -->
In this block it doesn't.
<!-- mkdocs-spellcheck-on -->
Here spelling checks are performed again.
Sponsors
And 4 more private sponsor(s).
Metadata
Release files for mkdocs-spellcheck 1.2.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mkdocs_spellcheck-1.2.2.tar.gz | 40.8 kB | Without provenance | Details for mkdocs_spellcheck-1.2.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mkdocs_spellcheck-1.2.2-py3-none-any.whl | Python 3 | none | any | Details for mkdocs_spellcheck-1.2.2-py3-none-any.whl |
Total release size: 63.0 kB
Release files / mkdocs_spellcheck-1.2.2.tar.gz
| Download URL | mkdocs_spellcheck-1.2.2.tar.gz |
|---|---|
| Size | 40.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7676bcc84df73d9169c4e5430929564089b68fad9d0b187fcc5fb0d8bdda1ab5
|
|
BLAKE2b-256 checksum How to use checksums |
01f509aaca7201cd07325ffb1670349a5bdf46ca41ba9ac6726ffcbaa85a634d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.8
|
Release files / mkdocs_spellcheck-1.2.2-py3-none-any.whl
| Download URL | mkdocs_spellcheck-1.2.2-py3-none-any.whl |
|---|---|
| Size | 22.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e808e44dc7b716dd5ec18a85ad650ceee10a6ba9b495c794516fd1a8636abe9c
|
|
BLAKE2b-256 checksum How to use checksums |
58f8da07e8fc8cf31df79c1c97683e471fd87d8e863d9d8f03e8f6612bdeafc7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.8
|
Security for mkdocs-spellcheck 1.2.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.