Merge pull request #18 from yarikoptic/enh-codespell

Add codespell support (config, workflow to detect/not fix) and make it fix a typo

.codespellrc

@@ -0,0 +1,6 @@
+[codespell]
+# Ref: https://github.com/codespell-project/codespell#using-a-config-file
+skip = .git*,*.css,*.min.*,.codespellrc,mkdocs-test-gh-pages
+check-hidden = true
+# ignore-regex = 
+# ignore-words-list =

.github/workflows/codespell.yml

@@ -0,0 +1,25 @@
+# Codespell configuration is within .codespellrc
+---
+name: Codespell
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Annotate locations with typos
+        uses: codespell-project/codespell-problem-matcher@v1
+      - name: Codespell
+        uses: codespell-project/actions-codespell@v2

docs/Usage.md

@@ -14,7 +14,7 @@ graph TD
 
 ```
 
-The key for the activation can be [configuered or disabled](./index.md#use-different-key)!
+The key for the activation can be [configured or disabled](./index.md#use-different-key)!
 
 ## Mouse