mkdocs-spellcheck 1.2.0__tar.gz → 1.2.1__tar.gz

{mkdocs_spellcheck-1.2.0 → mkdocs_spellcheck-1.2.1}/CHANGELOG.md

@@ -5,6 +5,14 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 <!-- insertion marker -->
+## [1.2.1](https://github.com/pawamoy/mkdocs-spellcheck/releases/tag/1.2.1) - 2026-02-11
+
+<small>[Compare with 1.2.0](https://github.com/pawamoy/mkdocs-spellcheck/compare/1.2.0...1.2.1)</small>
+
+### Bug Fixes
+
+- Ignore contents of `<script>` tags ([80c72bc](https://github.com/pawamoy/mkdocs-spellcheck/commit/80c72bc8af46fd114cea75ba2628df2d46495d98) by Tino Wagner). [PR-40](https://github.com/pawamoy/mkdocs-spellcheck/pull/40)
+
 ## [1.2.0](https://github.com/pawamoy/mkdocs-spellcheck/releases/tag/1.2.0) - 2025-12-01
 
 <small>[Compare with 1.1.2](https://github.com/pawamoy/mkdocs-spellcheck/compare/1.1.2...1.2.0)</small>

mkdocs_spellcheck-1.2.1/PKG-INFO

@@ -0,0 +1,197 @@
+Metadata-Version: 2.4
+Name: mkdocs-spellcheck
+Version: 1.2.1
+Summary: A spell checker plugin for MkDocs.
+Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
+License-Expression: ISC
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Project-URL: Homepage, https://pawamoy.github.io/mkdocs-spellcheck
+Project-URL: Documentation, https://pawamoy.github.io/mkdocs-spellcheck
+Project-URL: Changelog, https://pawamoy.github.io/mkdocs-spellcheck/changelog
+Project-URL: Repository, https://github.com/pawamoy/mkdocs-spellcheck
+Project-URL: Issues, https://github.com/pawamoy/mkdocs-spellcheck/issues
+Project-URL: Discussions, https://github.com/pawamoy/mkdocs-spellcheck/discussions
+Project-URL: Gitter, https://gitter.im/mkdocs-spellcheck/community
+Project-URL: Funding, https://github.com/sponsors/pawamoy
+Requires-Python: >=3.10
+Requires-Dist: mkdocs>=1.5
+Provides-Extra: all
+Requires-Dist: mkdocs-spellcheck[codespell,symspellpy]; extra == "all"
+Provides-Extra: codespell
+Requires-Dist: codespell>=2.2.2; extra == "codespell"
+Provides-Extra: symspellpy
+Requires-Dist: symspellpy>=6.7.6; extra == "symspellpy"
+Requires-Dist: importlib-resources>=6.4; python_version < "3.9" and extra == "symspellpy"
+Description-Content-Type: text/markdown
+
+# MkDocs SpellCheck
+
+> [!WARNING]
+> This project is in maintenance mode. I'm now dedicating my time to [Zensical](https://zensical.org/). Feel free to reach out for a responsible transfer of maintainership.
+
+[![ci](https://github.com/pawamoy/mkdocs-spellcheck/workflows/ci/badge.svg)](https://github.com/pawamoy/mkdocs-spellcheck/actions?query=workflow%3Aci)
+[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://pawamoy.github.io/mkdocs-spellcheck/)
+[![pypi version](https://img.shields.io/pypi/v/mkdocs-spellcheck.svg)](https://pypi.org/project/mkdocs-spellcheck/)
+[![gitter](https://img.shields.io/badge/matrix-chat-4DB798.svg?style=flat)](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.
+
+Once your configuration is ready, just run `mkdocs build -s` to check the spelling inside your pages.
+
+### `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`
+
+### 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}`:
+
+```md
+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
+
+<!-- sponsors-start -->
+
+<div id="premium-sponsors" style="text-align: center;">
+
+<div id="silver-sponsors"><b>Silver sponsors</b><p>
+<a href="https://fastapi.tiangolo.com/"><img alt="FastAPI" src="https://raw.githubusercontent.com/tiangolo/fastapi/master/docs/en/docs/img/logo-margin/logo-teal.png" style="height: 200px; "></a><br>
+</p></div>
+
+<div id="bronze-sponsors"><b>Bronze sponsors</b><p>
+<a href="https://www.nixtla.io/"><picture><source media="(prefers-color-scheme: light)" srcset="https://www.nixtla.io/img/logo/full-black.svg"><source media="(prefers-color-scheme: dark)" srcset="https://www.nixtla.io/img/logo/full-white.svg"><img alt="Nixtla" src="https://www.nixtla.io/img/logo/full-black.svg" style="height: 60px; "></picture></a><br>
+</p></div>
+</div>
+
+---
+
+<div id="sponsors"><p>
+<a href="https://github.com/ofek"><img alt="ofek" src="https://avatars.githubusercontent.com/u/9677399?u=386c330f212ce467ce7119d9615c75d0e9b9f1ce&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/samuelcolvin"><img alt="samuelcolvin" src="https://avatars.githubusercontent.com/u/4039449?u=42eb3b833047c8c4b4f647a031eaef148c16d93f&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/tlambert03"><img alt="tlambert03" src="https://avatars.githubusercontent.com/u/1609449?u=922abf0524b47739b37095e553c99488814b05db&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/ssbarnea"><img alt="ssbarnea" src="https://avatars.githubusercontent.com/u/102495?u=c7bd9ddf127785286fc939dd18cb02db0a453bce&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/femtomc"><img alt="femtomc" src="https://avatars.githubusercontent.com/u/34410036?u=f13a71daf2a9f0d2da189beaa94250daa629e2d8&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/cmarqu"><img alt="cmarqu" src="https://avatars.githubusercontent.com/u/360986?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/kolenaIO"><img alt="kolenaIO" src="https://avatars.githubusercontent.com/u/77010818?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/ramnes"><img alt="ramnes" src="https://avatars.githubusercontent.com/u/835072?u=3fca03c3ba0051e2eb652b1def2188a94d1e1dc2&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/machow"><img alt="machow" src="https://avatars.githubusercontent.com/u/2574498?u=c41e3d2f758a05102d8075e38d67b9c17d4189d7&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/BenHammersley"><img alt="BenHammersley" src="https://avatars.githubusercontent.com/u/99436?u=4499a7b507541045222ee28ae122dbe3c8d08ab5&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/trevorWieland"><img alt="trevorWieland" src="https://avatars.githubusercontent.com/u/28811461?u=74cc0e3756c1d4e3d66b5c396e1d131ea8a10472&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/MarcoGorelli"><img alt="MarcoGorelli" src="https://avatars.githubusercontent.com/u/33491632?u=7de3a749cac76a60baca9777baf71d043a4f884d&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/analog-cbarber"><img alt="analog-cbarber" src="https://avatars.githubusercontent.com/u/7408243?u=642fc2bdcc9904089c62fe5aec4e03ace32da67d&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/OdinManiac"><img alt="OdinManiac" src="https://avatars.githubusercontent.com/u/22727172?u=36ab20970f7f52ae8e7eb67b7fcf491fee01ac22&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/rstudio-sponsorship"><img alt="rstudio-sponsorship" src="https://avatars.githubusercontent.com/u/58949051?u=0c471515dd18111be30dfb7669ed5e778970959b&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/schlich"><img alt="schlich" src="https://avatars.githubusercontent.com/u/21191435?u=6f1240adb68f21614d809ae52d66509f46b1e877&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/butterlyn"><img alt="butterlyn" src="https://avatars.githubusercontent.com/u/53323535?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/livingbio"><img alt="livingbio" src="https://avatars.githubusercontent.com/u/10329983?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/NemetschekAllplan"><img alt="NemetschekAllplan" src="https://avatars.githubusercontent.com/u/912034?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/EricJayHartman"><img alt="EricJayHartman" src="https://avatars.githubusercontent.com/u/9259499?u=7e58cc7ec0cd3e85b27aec33656aa0f6612706dd&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/15r10nk"><img alt="15r10nk" src="https://avatars.githubusercontent.com/u/44680962?u=f04826446ff165742efa81e314bd03bf1724d50e&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/activeloopai"><img alt="activeloopai" src="https://avatars.githubusercontent.com/u/34816118?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/roboflow"><img alt="roboflow" src="https://avatars.githubusercontent.com/u/53104118?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/cmclaughlin"><img alt="cmclaughlin" src="https://avatars.githubusercontent.com/u/1061109?u=ddf6eec0edd2d11c980f8c3aa96e3d044d4e0468&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/blaisep"><img alt="blaisep" src="https://avatars.githubusercontent.com/u/254456?u=97d584b7c0a6faf583aa59975df4f993f671d121&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/RapidataAI"><img alt="RapidataAI" src="https://avatars.githubusercontent.com/u/104209891?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/rodolphebarbanneau"><img alt="rodolphebarbanneau" src="https://avatars.githubusercontent.com/u/46493454?u=6c405452a40c231cdf0b68e97544e07ee956a733&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/theSymbolSyndicate"><img alt="theSymbolSyndicate" src="https://avatars.githubusercontent.com/u/111542255?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/blakeNaccarato"><img alt="blakeNaccarato" src="https://avatars.githubusercontent.com/u/20692450?u=bb919218be30cfa994514f4cf39bb2f7cf952df4&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/ChargeStorm"><img alt="ChargeStorm" src="https://avatars.githubusercontent.com/u/26000165?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/Alphadelta14"><img alt="Alphadelta14" src="https://avatars.githubusercontent.com/u/480845?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/Cusp-AI"><img alt="Cusp-AI" src="https://avatars.githubusercontent.com/u/178170649?v=4" style="height: 32px; border-radius: 100%;"></a>
+</p></div>
+
+
+*And 7 more private sponsor(s).*
+
+<!-- sponsors-end -->
+

mkdocs_spellcheck-1.2.1/README.md

@@ -0,0 +1,156 @@
+# MkDocs SpellCheck
+
+> [!WARNING]
+> This project is in maintenance mode. I'm now dedicating my time to [Zensical](https://zensical.org/). Feel free to reach out for a responsible transfer of maintainership.
+
+[![ci](https://github.com/pawamoy/mkdocs-spellcheck/workflows/ci/badge.svg)](https://github.com/pawamoy/mkdocs-spellcheck/actions?query=workflow%3Aci)
+[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://pawamoy.github.io/mkdocs-spellcheck/)
+[![pypi version](https://img.shields.io/pypi/v/mkdocs-spellcheck.svg)](https://pypi.org/project/mkdocs-spellcheck/)
+[![gitter](https://img.shields.io/badge/matrix-chat-4DB798.svg?style=flat)](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.
+
+Once your configuration is ready, just run `mkdocs build -s` to check the spelling inside your pages.
+
+### `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`
+
+### 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}`:
+
+```md
+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
+
+<!-- sponsors-start -->
+
+<div id="premium-sponsors" style="text-align: center;">
+
+<div id="silver-sponsors"><b>Silver sponsors</b><p>
+<a href="https://fastapi.tiangolo.com/"><img alt="FastAPI" src="https://raw.githubusercontent.com/tiangolo/fastapi/master/docs/en/docs/img/logo-margin/logo-teal.png" style="height: 200px; "></a><br>
+</p></div>
+
+<div id="bronze-sponsors"><b>Bronze sponsors</b><p>
+<a href="https://www.nixtla.io/"><picture><source media="(prefers-color-scheme: light)" srcset="https://www.nixtla.io/img/logo/full-black.svg"><source media="(prefers-color-scheme: dark)" srcset="https://www.nixtla.io/img/logo/full-white.svg"><img alt="Nixtla" src="https://www.nixtla.io/img/logo/full-black.svg" style="height: 60px; "></picture></a><br>
+</p></div>
+</div>
+
+---
+
+<div id="sponsors"><p>
+<a href="https://github.com/ofek"><img alt="ofek" src="https://avatars.githubusercontent.com/u/9677399?u=386c330f212ce467ce7119d9615c75d0e9b9f1ce&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/samuelcolvin"><img alt="samuelcolvin" src="https://avatars.githubusercontent.com/u/4039449?u=42eb3b833047c8c4b4f647a031eaef148c16d93f&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/tlambert03"><img alt="tlambert03" src="https://avatars.githubusercontent.com/u/1609449?u=922abf0524b47739b37095e553c99488814b05db&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/ssbarnea"><img alt="ssbarnea" src="https://avatars.githubusercontent.com/u/102495?u=c7bd9ddf127785286fc939dd18cb02db0a453bce&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/femtomc"><img alt="femtomc" src="https://avatars.githubusercontent.com/u/34410036?u=f13a71daf2a9f0d2da189beaa94250daa629e2d8&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/cmarqu"><img alt="cmarqu" src="https://avatars.githubusercontent.com/u/360986?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/kolenaIO"><img alt="kolenaIO" src="https://avatars.githubusercontent.com/u/77010818?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/ramnes"><img alt="ramnes" src="https://avatars.githubusercontent.com/u/835072?u=3fca03c3ba0051e2eb652b1def2188a94d1e1dc2&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/machow"><img alt="machow" src="https://avatars.githubusercontent.com/u/2574498?u=c41e3d2f758a05102d8075e38d67b9c17d4189d7&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/BenHammersley"><img alt="BenHammersley" src="https://avatars.githubusercontent.com/u/99436?u=4499a7b507541045222ee28ae122dbe3c8d08ab5&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/trevorWieland"><img alt="trevorWieland" src="https://avatars.githubusercontent.com/u/28811461?u=74cc0e3756c1d4e3d66b5c396e1d131ea8a10472&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/MarcoGorelli"><img alt="MarcoGorelli" src="https://avatars.githubusercontent.com/u/33491632?u=7de3a749cac76a60baca9777baf71d043a4f884d&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/analog-cbarber"><img alt="analog-cbarber" src="https://avatars.githubusercontent.com/u/7408243?u=642fc2bdcc9904089c62fe5aec4e03ace32da67d&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/OdinManiac"><img alt="OdinManiac" src="https://avatars.githubusercontent.com/u/22727172?u=36ab20970f7f52ae8e7eb67b7fcf491fee01ac22&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/rstudio-sponsorship"><img alt="rstudio-sponsorship" src="https://avatars.githubusercontent.com/u/58949051?u=0c471515dd18111be30dfb7669ed5e778970959b&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/schlich"><img alt="schlich" src="https://avatars.githubusercontent.com/u/21191435?u=6f1240adb68f21614d809ae52d66509f46b1e877&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/butterlyn"><img alt="butterlyn" src="https://avatars.githubusercontent.com/u/53323535?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/livingbio"><img alt="livingbio" src="https://avatars.githubusercontent.com/u/10329983?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/NemetschekAllplan"><img alt="NemetschekAllplan" src="https://avatars.githubusercontent.com/u/912034?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/EricJayHartman"><img alt="EricJayHartman" src="https://avatars.githubusercontent.com/u/9259499?u=7e58cc7ec0cd3e85b27aec33656aa0f6612706dd&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/15r10nk"><img alt="15r10nk" src="https://avatars.githubusercontent.com/u/44680962?u=f04826446ff165742efa81e314bd03bf1724d50e&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/activeloopai"><img alt="activeloopai" src="https://avatars.githubusercontent.com/u/34816118?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/roboflow"><img alt="roboflow" src="https://avatars.githubusercontent.com/u/53104118?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/cmclaughlin"><img alt="cmclaughlin" src="https://avatars.githubusercontent.com/u/1061109?u=ddf6eec0edd2d11c980f8c3aa96e3d044d4e0468&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/blaisep"><img alt="blaisep" src="https://avatars.githubusercontent.com/u/254456?u=97d584b7c0a6faf583aa59975df4f993f671d121&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/RapidataAI"><img alt="RapidataAI" src="https://avatars.githubusercontent.com/u/104209891?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/rodolphebarbanneau"><img alt="rodolphebarbanneau" src="https://avatars.githubusercontent.com/u/46493454?u=6c405452a40c231cdf0b68e97544e07ee956a733&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/theSymbolSyndicate"><img alt="theSymbolSyndicate" src="https://avatars.githubusercontent.com/u/111542255?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/blakeNaccarato"><img alt="blakeNaccarato" src="https://avatars.githubusercontent.com/u/20692450?u=bb919218be30cfa994514f4cf39bb2f7cf952df4&v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/ChargeStorm"><img alt="ChargeStorm" src="https://avatars.githubusercontent.com/u/26000165?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/Alphadelta14"><img alt="Alphadelta14" src="https://avatars.githubusercontent.com/u/480845?v=4" style="height: 32px; border-radius: 100%;"></a>
+<a href="https://github.com/Cusp-AI"><img alt="Cusp-AI" src="https://avatars.githubusercontent.com/u/178170649?v=4" style="height: 32px; border-radius: 100%;"></a>
+</p></div>
+
+
+*And 7 more private sponsor(s).*
+
+<!-- sponsors-end -->
+

{mkdocs_spellcheck-1.2.0 → mkdocs_spellcheck-1.2.1}/docs/known_words.txt

@@ -36,3 +36,5 @@ symspellpy
 autolinks
 deprecations
 submodules
+maintainership
+zensical

{mkdocs_spellcheck-1.2.0 → mkdocs_spellcheck-1.2.1}/pyproject.toml

@@ -38,7 +38,7 @@ classifiers = [
 dependencies = [
     "mkdocs>=1.5",
 ]
-version = "1.2.0"
+version = "1.2.1"
 
 [project.optional-dependencies]
 all = [

{mkdocs_spellcheck-1.2.0 → mkdocs_spellcheck-1.2.1}/scripts/gen_credits.py

@@ -55,7 +55,7 @@ def _extra_marker(req: Requirement) -> str | None:
     if not req.marker:
         return None
     try:
-        return next(marker[2].value for marker in req.marker._markers if getattr(marker[0], "value", None) == "extra")
+        return next(marker[2].value for marker in req.marker._markers if getattr(marker[0], "value", None) == "extra")  # type: ignore[union-attr]
     except StopIteration:
         return None
 

{mkdocs_spellcheck-1.2.0 → mkdocs_spellcheck-1.2.1}/src/mkdocs_spellcheck/_internal/words.py

@@ -21,16 +21,21 @@ class _MLStripper(HTMLParser):
         self.text = StringIO()
         self.ignore_code = ignore_code
         self.in_code_tag = False
+        self.in_script_tag = False
         self.in_guard = False
 
     def handle_starttag(self, tag: str, attrs: list[tuple[str, str | None]]) -> None:  # noqa: ARG002
         if tag == "code":
             self.in_code_tag = True
+        if tag == "script":
+            self.in_script_tag = True
         self.text.write(" ")
 
     def handle_endtag(self, tag: str) -> None:
         if tag == "code":
             self.in_code_tag = False
+        if tag == "script":
+            self.in_script_tag = False
 
     def handle_comment(self, data: str) -> None:
         data = data.strip()
@@ -45,6 +50,9 @@ class _MLStripper(HTMLParser):
         if self.ignore_code and self.in_code_tag:
             return
 
+        if self.in_script_tag:
+            return
+
         if self.in_guard:
             return
 

{mkdocs_spellcheck-1.2.0 → mkdocs_spellcheck-1.2.1}/tests/test_api.py

@@ -50,7 +50,7 @@ def _yield_public_objects(
                 if modules:
                     yield member
                 yield from _yield_public_objects(
-                    member,  # type: ignore[arg-type]
+                    member,
                     modules=modules,
                     modulelevel=modulelevel,
                     inherited=inherited,
@@ -62,7 +62,7 @@ def _yield_public_objects(
                 continue
             if member.is_class and not modulelevel:
                 yield from _yield_public_objects(
-                    member,  # type: ignore[arg-type]
+                    member,
                     modules=modules,
                     modulelevel=False,
                     inherited=inherited,

mkdocs_spellcheck-1.2.0/PKG-INFO

@@ -1,145 +0,0 @@
-Metadata-Version: 2.4
-Name: mkdocs-spellcheck
-Version: 1.2.0
-Summary: A spell checker plugin for MkDocs.
-Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
-License-Expression: ISC
-License-File: LICENSE
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Classifier: Topic :: Documentation
-Classifier: Topic :: Software Development
-Classifier: Topic :: Software Development :: Documentation
-Classifier: Topic :: Utilities
-Classifier: Typing :: Typed
-Project-URL: Homepage, https://pawamoy.github.io/mkdocs-spellcheck
-Project-URL: Documentation, https://pawamoy.github.io/mkdocs-spellcheck
-Project-URL: Changelog, https://pawamoy.github.io/mkdocs-spellcheck/changelog
-Project-URL: Repository, https://github.com/pawamoy/mkdocs-spellcheck
-Project-URL: Issues, https://github.com/pawamoy/mkdocs-spellcheck/issues
-Project-URL: Discussions, https://github.com/pawamoy/mkdocs-spellcheck/discussions
-Project-URL: Gitter, https://gitter.im/mkdocs-spellcheck/community
-Project-URL: Funding, https://github.com/sponsors/pawamoy
-Requires-Python: >=3.10
-Requires-Dist: mkdocs>=1.5
-Provides-Extra: all
-Requires-Dist: mkdocs-spellcheck[codespell,symspellpy]; extra == "all"
-Provides-Extra: codespell
-Requires-Dist: codespell>=2.2.2; extra == "codespell"
-Provides-Extra: symspellpy
-Requires-Dist: symspellpy>=6.7.6; extra == "symspellpy"
-Requires-Dist: importlib-resources>=6.4; python_version < "3.9" and extra == "symspellpy"
-Description-Content-Type: text/markdown
-
-# MkDocs SpellCheck
-
-> [!WARNING]
-> This project is in maintenance mode. I'm now dedicating my time to [Zensical](https://zensical.org/). Feel free to reach out for a responsible transfer of maintainership.
-
-[![ci](https://github.com/pawamoy/mkdocs-spellcheck/workflows/ci/badge.svg)](https://github.com/pawamoy/mkdocs-spellcheck/actions?query=workflow%3Aci)
-[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://pawamoy.github.io/mkdocs-spellcheck/)
-[![pypi version](https://img.shields.io/pypi/v/mkdocs-spellcheck.svg)](https://pypi.org/project/mkdocs-spellcheck/)
-[![gitter](https://img.shields.io/badge/matrix-chat-4DB798.svg?style=flat)](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.
-
-Once your configuration is ready, just run `mkdocs build -s` to check the spelling inside your pages.
-
-### `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`
-
-### 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}`:
-
-```md
-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
-
-<!-- sponsors-start -->
-<!-- sponsors-end -->
-

mkdocs_spellcheck-1.2.0/README.md

@@ -1,104 +0,0 @@
-# MkDocs SpellCheck
-
-> [!WARNING]
-> This project is in maintenance mode. I'm now dedicating my time to [Zensical](https://zensical.org/). Feel free to reach out for a responsible transfer of maintainership.
-
-[![ci](https://github.com/pawamoy/mkdocs-spellcheck/workflows/ci/badge.svg)](https://github.com/pawamoy/mkdocs-spellcheck/actions?query=workflow%3Aci)
-[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://pawamoy.github.io/mkdocs-spellcheck/)
-[![pypi version](https://img.shields.io/pypi/v/mkdocs-spellcheck.svg)](https://pypi.org/project/mkdocs-spellcheck/)
-[![gitter](https://img.shields.io/badge/matrix-chat-4DB798.svg?style=flat)](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.
-
-Once your configuration is ready, just run `mkdocs build -s` to check the spelling inside your pages.
-
-### `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`
-
-### 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}`:
-
-```md
-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
-
-<!-- sponsors-start -->
-<!-- sponsors-end -->
-