build: add spellcheck

Incendo · Dec 22, 2023 · 9654557 · 9654557
1 parent bf1bdab
commit 9654557
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 0 deletions.
diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml
@@ -0,0 +1,11 @@
+name: Spellcheck Action
+on: push
+
+jobs:
+  build:
+    name: Spellcheck
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: rojopolis/[email protected]
+        name: Spellcheck
diff --git a/.spellcheck.yml b/.spellcheck.yml
@@ -0,0 +1,19 @@
+matrix:
+  - name: Markdown
+    aspell:
+      lang: en
+    dictionary:
+      encoding: utf-8
+    pipeline:
+      - pyspelling.filters.markdown:
+          markdown_extensions:
+            - pymdownx.superfences
+            - pymdownx.tabbed
+      - pyspelling.filters.html:
+          comments: false
+          ignores:
+            - code
+            - pre
+    sources:
+      - "docs/**/*.md"
+    default_encoding: utf-8