{"id":15663292,"url":"https://github.com/pawamoy/mkdocs-spellcheck","last_synced_at":"2025-07-10T17:04:28.756Z","repository":{"id":86200108,"uuid":"451105678","full_name":"pawamoy/mkdocs-spellcheck","owner":"pawamoy","description":"A spell checker plugin for MkDocs.","archived":false,"fork":false,"pushed_at":"2025-03-26T13:46:34.000Z","size":1342,"stargazers_count":19,"open_issues_count":7,"forks_count":4,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-06-07T04:18:59.198Z","etag":null,"topics":["mkdocs","spell-check","spell-checker","spellcheck","spellchecker","spelling","spelling-correction"],"latest_commit_sha":null,"homepage":"https://pawamoy.github.io/mkdocs-spellcheck/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pawamoy.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"pawamoy","polar":"pawamoy"}},"created_at":"2022-01-23T13:03:19.000Z","updated_at":"2025-03-26T13:46:22.000Z","dependencies_parsed_at":"2024-01-18T20:42:48.514Z","dependency_job_id":"e2c46b27-70e5-4d75-8c48-3cc19f427a81","html_url":"https://github.com/pawamoy/mkdocs-spellcheck","commit_stats":{"total_commits":60,"total_committers":4,"mean_commits":15.0,"dds":0.09999999999999998,"last_synced_commit":"e0e5c75534c589b2109049e567c4f45d72f9a7c7"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/pawamoy/mkdocs-spellcheck","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pawamoy%2Fmkdocs-spellcheck","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pawamoy%2Fmkdocs-spellcheck/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pawamoy%2Fmkdocs-spellcheck/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pawamoy%2Fmkdocs-spellcheck/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pawamoy","download_url":"https://codeload.github.com/pawamoy/mkdocs-spellcheck/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pawamoy%2Fmkdocs-spellcheck/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264502416,"owners_count":23618600,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mkdocs","spell-check","spell-checker","spellcheck","spellchecker","spelling","spelling-correction"],"created_at":"2024-10-03T13:36:24.062Z","updated_at":"2025-07-10T17:04:28.729Z","avatar_url":"https://github.com/pawamoy.png","language":"Python","funding_links":["https://github.com/sponsors/pawamoy","https://polar.sh/pawamoy"],"categories":[],"sub_categories":[],"readme":"# MkDocs SpellCheck\n\n[![ci](https://github.com/pawamoy/mkdocs-spellcheck/workflows/ci/badge.svg)](https://github.com/pawamoy/mkdocs-spellcheck/actions?query=workflow%3Aci)\n[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://pawamoy.github.io/mkdocs-spellcheck/)\n[![pypi version](https://img.shields.io/pypi/v/mkdocs-spellcheck.svg)](https://pypi.org/project/mkdocs-spellcheck/)\n[![gitter](https://badges.gitter.im/join%20chat.svg)](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. Otherwise 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 \u003ccode\u003e 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\nOnce your configuration is ready, just run `mkdocs build -s` to check the spelling inside your pages.\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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpawamoy%2Fmkdocs-spellcheck","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpawamoy%2Fmkdocs-spellcheck","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpawamoy%2Fmkdocs-spellcheck/lists"}