| Name | mkdocs-spellcheck JSON |
| Version |
1.1.0
JSON |
| download |
| home_page | None |
| Summary | A spell checker plugin for MkDocs. |
| upload_time | 2024-05-06 13:17:47 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | ISC |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# MkDocs SpellCheck
[](https://github.com/pawamoy/mkdocs-spellcheck/actions?query=workflow%3Aci)
[](https://pawamoy.github.io/mkdocs-spellcheck/)
[](https://pypi.org/project/mkdocs-spellcheck/)
[](https://gitpod.io/#https://github.com/pawamoy/mkdocs-spellcheck)
[](https://app.gitter.im/#/room/#mkdocs-spellcheck:gitter.im)
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:
- [`codespell`](https://github.com/codespell-project/codespell)
- [`symspellpy`](https://github.com/mammothb/symspellpy)
## Installation
To install all backends, use the `all` extra.
Otherwise specify the name(s) of the backend(s) as extra.
```bash
pip install mkdocs-spellcheck[all]
pip install mkdocs-spellcheck[codespell]
pip install mkdocs-spellcheck[symspellpy]
pip install mkdocs-spellcheck[codespell,symspellpy]
```
## Usage
```yaml
# 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.
### `codespell`
The builtin dictionaries are:
- `clear` for unambiguous errors
- `rare` for rare (but valid) words that are likely to be errors
- `informal` for making informal words more formal
- `usage` for replacing phrasing with recommended terms
- `code` for words from code and/or mathematics that are likely
to be typos in other contexts (such as `uint`)
- `names` for valid proper names that might be typos
- `en-GB_to_en-US` for corrections from `en-GB` to `en-US`
Raw data
{
"_id": null,
"home_page": null,
"name": "mkdocs-spellcheck",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "=?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>",
"download_url": "https://files.pythonhosted.org/packages/ac/89/0921b8e18c9e3926cf4e753a404b4d7d406260bc2d653b43186ce608908a/mkdocs_spellcheck-1.1.0.tar.gz",
"platform": null,
"description": "# MkDocs SpellCheck\n\n[](https://github.com/pawamoy/mkdocs-spellcheck/actions?query=workflow%3Aci)\n[](https://pawamoy.github.io/mkdocs-spellcheck/)\n[](https://pypi.org/project/mkdocs-spellcheck/)\n[](https://gitpod.io/#https://github.com/pawamoy/mkdocs-spellcheck)\n[](https://app.gitter.im/#/room/#mkdocs-spellcheck:gitter.im)\n\nA spell checker plugin for MkDocs.\n\nThis plugin can use different backends\nto check the spelling of words in your final HTML pages.\nThese backends are:\n\n- [`codespell`](https://github.com/codespell-project/codespell)\n- [`symspellpy`](https://github.com/mammothb/symspellpy)\n\n## Installation\n\nTo install all backends, use the `all` extra.\nOtherwise specify the name(s) of the backend(s) as extra.\n\n```bash\npip install mkdocs-spellcheck[all]\npip install mkdocs-spellcheck[codespell]\npip install mkdocs-spellcheck[symspellpy]\npip install mkdocs-spellcheck[codespell,symspellpy]\n```\n\n## Usage\n\n```yaml\n# mkdocs.yml\nplugins:\n- search\n- spellcheck:\n backends: # the backends you want to use\n - symspellpy # as strings\n - codespell: # or nested configs\n dictionaries: [clear, rare]\n\n # known_words can also be a list of words\n known_words: known_words.txt\n\n # ignore words in <code> tags\n ignore_code: yes\n\n # minimum length of words to consider\n min_length: 2\n\n # maximum number of capital letters in a word\n max_capital: 1\n\n # keep unicode characters\n allow_unicode: no\n\n # skip files entirely (supports Unix shell-style wildcards)\n skip_files:\n - credits.md\n - coverage.md\n - reference/* \n\n # whether to only check in strict mode\n strict_only: yes\n```\n\nBy default, the `symspellpy` backend is used.\n\n### `codespell`\n\nThe builtin dictionaries are:\n\n- `clear` for unambiguous errors\n- `rare` for rare (but valid) words that are likely to be errors\n- `informal` for making informal words more formal\n- `usage` for replacing phrasing with recommended terms\n- `code` for words from code and/or mathematics that are likely\n to be typos in other contexts (such as `uint`)\n- `names` for valid proper names that might be typos\n- `en-GB_to_en-US` for corrections from `en-GB` to `en-US`\n",
"bugtrack_url": null,
"license": "ISC",
"summary": "A spell checker plugin for MkDocs.",
"version": "1.1.0",
"project_urls": {
"Changelog": "https://pawamoy.github.io/mkdocs-spellcheck/changelog",
"Discussions": "https://github.com/pawamoy/mkdocs-spellcheck/discussions",
"Documentation": "https://pawamoy.github.io/mkdocs-spellcheck",
"Funding": "https://github.com/sponsors/pawamoy",
"Gitter": "https://gitter.im/mkdocs-spellcheck/community",
"Homepage": "https://pawamoy.github.io/mkdocs-spellcheck",
"Issues": "https://github.com/pawamoy/mkdocs-spellcheck/issues",
"Repository": "https://github.com/pawamoy/mkdocs-spellcheck"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e9b83bd1aa5e2b8575c7f5073ffdb317e3c1ef5f10c14c4ba080b7e779a483ba",
"md5": "52389f5ae0201c9ff47e97effa5efd42",
"sha256": "476ef27d11b7765568670f811a90beb77ec47f9da7cea9708e935371c969457f"
},
"downloads": -1,
"filename": "mkdocs_spellcheck-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "52389f5ae0201c9ff47e97effa5efd42",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10992,
"upload_time": "2024-05-06T13:17:46",
"upload_time_iso_8601": "2024-05-06T13:17:46.081139Z",
"url": "https://files.pythonhosted.org/packages/e9/b8/3bd1aa5e2b8575c7f5073ffdb317e3c1ef5f10c14c4ba080b7e779a483ba/mkdocs_spellcheck-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ac890921b8e18c9e3926cf4e753a404b4d7d406260bc2d653b43186ce608908a",
"md5": "3b0dd8b3830dee24b08b9713669e6a3c",
"sha256": "2c2ac481e067f9d833d8fd1236acb8e6e76106581f909117eaf41ef1b6a5c69c"
},
"downloads": -1,
"filename": "mkdocs_spellcheck-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "3b0dd8b3830dee24b08b9713669e6a3c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 10639,
"upload_time": "2024-05-06T13:17:47",
"upload_time_iso_8601": "2024-05-06T13:17:47.653600Z",
"url": "https://files.pythonhosted.org/packages/ac/89/0921b8e18c9e3926cf4e753a404b4d7d406260bc2d653b43186ce608908a/mkdocs_spellcheck-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-06 13:17:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pawamoy",
"github_project": "mkdocs-spellcheck",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mkdocs-spellcheck"
}
