mkdocs-spellcheck
A spell checker plugin for MkDocs.
Decision gist · record as of 2026-08-14
Yes, if you maintain MkDocs documentation and want automated spell checking. The plugin is low-friction to install, permissively licensed, and works with modern Python. However, the aging maintenance status and explicit statement that the maintainer is dedicating effort elsewhere means you should be prepared to fork or switch if critical issues arise. For new projects or teams with active documentation workflows, it's a solid choice; for mission-critical systems, monitor the project's activity.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.10 or later; one of the optional backends (codespell or symspellpy) must be installed via extras.
- Low friction: pure Python wheel with a single runtime dependency on mkdocs.
- Maintenance status is aging—last release was 184 days ago and the maintainer has explicitly stated the project is in maintenance mode, dedicating effort elsewhere.
License · maintenance · safety
ISC (permissive) — ISC license is permissive and imposes minimal restrictions; you can use, modify, and distribute the package freely with minimal legal friction.
last release 2026-02-11 (184 days) · last repo commit 2026-02-11 · 22 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 87,117 downloads/mo, #13,814 on PyPI
Alternatives
Verify before relying
pip install 'mkdocs-spellcheck[all]'
# In mkdocs.yml:
plugins:
- spellcheck:
backends:
- symspellpy
- codespell:
dictionaries: [clear, rare]
known_words: known_words.txt
ignore_code: yes
# Then run:
mkdocs build -s- Whether the aging maintenance status poses a risk for future Python or mkdocs compatibility issues.
- How well the plugin performs on large documentation sites or whether there are known performance bottlenecks.
- Whether the two backends (codespell and symspellpy) have materially different accuracy or speed characteristics.
What it is and what it does
mkdocs-spellcheck is a MkDocs plugin that runs spell-checking on your final built HTML documentation. It integrates with your build pipeline and can use either codespell or symspellpy as its checking backend, each with different dictionary options and tuning parameters. You configure it in mkdocs.yml to specify which backend(s) to use, custom word lists, code-block handling, and file exclusions, then invoke it during the build step with mkdocs build -s.
The plugin is designed to catch typos and spelling errors before documentation is published. It supports granular configuration—minimum word length, capital-letter thresholds, Unicode handling, and on-off regions in Markdown to skip checking in specific blocks. The project is currently in maintenance mode, meaning bug fixes and security updates may be limited, though the codebase is stable and supports modern Python versions (3.10 through 3.14).
Use it for
- Catch spelling errors in technical documentation before publishing to ensure professionalism.
- Enforce consistent spelling conventions across large documentation sites using custom dictionaries.
- Integrate spell checking into CI/CD pipelines to fail builds when typos are detected.
- Exclude code snippets and proper names from spell checking while validating prose.
- Temporarily disable spell checking for specific sections using on-off comment guards.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you maintain MkDocs documentation and want automated spell checking.
The plugin is low-friction to install, permissively licensed, and works with modern Python. However, the aging maintenance status and explicit statement that the maintainer is dedicating effort elsewhere means you should be prepared to fork or switch if critical issues arise. For new projects or teams with active documentation workflows, it's a solid choice; for mission-critical systems, monitor the project's activity.
Install
mkdocs-spellcheck on PyPI
Before you install
Low friction: pure Python wheel with a single runtime dependency on mkdocs. Maintenance status is aging—last release was 184 days ago and the maintainer has explicitly stated the project is in maintenance mode, dedicating effort elsewhere.
Requires Python 3.10 or later; one of the optional backends (codespell or symspellpy) must be installed via extras.
License in practice
ISC license is permissive and imposes minimal restrictions; you can use, modify, and distribute the package freely with minimal legal friction.
Quickstart
pip install 'mkdocs-spellcheck[all]'
# In mkdocs.yml:
plugins:
- spellcheck:
backends:
- symspellpy
- codespell:
dictionaries: [clear, rare]
known_words: known_words.txt
ignore_code: yes
# Then run:
mkdocs build -sVerify before relying
- Whether the aging maintenance status poses a risk for future Python or mkdocs compatibility issues.
- How well the plugin performs on large documentation sites or whether there are known performance bottlenecks.
- Whether the two backends (codespell and symspellpy) have materially different accuracy or speed characteristics.
Package facts
| License | ISC permissive |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 1 packagemkdocs |
| Maintenance | Aging 184 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 87,117 / month, #13,814 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 4 - BetaIntended Audience :: DevelopersProgramming Language :: PythonProgramming Language :: Python :: 3Programming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Topic :: DocumentationTopic :: Software DevelopmentTopic :: Software Development :: DocumentationTopic :: UtilitiesTyping :: Typed |
Evidence: mkdocs_spellcheck-1.2.1-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “mkdocs spell checker plugin”
- mkdocs-spellcheckA spell checker plugin for MkDocs that validates spelling in…
- mkdocs-htmlproofer-pluginA MkDocs plugin that validates URLs and anchors in rendered HTML…
- pyspellcheckerDetects misspelled words and suggests corrections using Levenshtein…
Give your agent the search over MCP, or paste the wish link into any chat.
More Software Development packages
Provides backported and experimental type hints for Python 3.9+, allowing use of newer typing features on older Python versions and enabling early experimentation with type system PEPs before they enter the standard library.
NumPy provides an N-dimensional array object and a comprehensive suite of mathematical, linear algebra, Fourier transform, and random number functions for scientific computing in Python.
FastAPI is a Python web framework for building REST APIs using type hints, with automatic request validation, serialization, and interactive API documentation.
Provides a way to document function parameters, class attributes, return types, and variables inline using Python's `Annotated` type hint syntax instead of traditional docstrings.
Typer builds command-line applications from Python functions using type hints, automatically generating help text, argument parsing, and shell completion.
Install it if you are building CLIs in Python.
Distlib provides low-level packaging utilities for building, distributing, and managing Python software—including metadata handling, version specifiers, wheel support, script installation, and dependency resolution.
See also codespell · typos · symspellpy · pyspelling · mkdocstrings · mkdocs-awesome-pages-plugin · sphinxcontrib-spelling · pyspellchecker · mkdocs · zensical