Merge pull request #3 from susanshi/spellcheck

add spell check workflow

.github/workflows/spelling_action.yml

@@ -0,0 +1,25 @@
+name: Spellcheck Action
+
+on:
+  pull_request:
+    branches:
+      - dev
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Spellcheck
+    runs-on: ubuntu-latest
+    steps:
+    # The checkout step
+    - uses: actions/checkout@v3
+    - uses: rojopolis/spellcheck-github-actions@0.41.0
+      name: Spellcheck
+      with:
+        config_path: config/.spellcheck.yml # put path to configuration file here
+        task_name: Markdown
+    - uses: actions/upload-artifact@v3
+      if: '!cancelled()' # Do not upload artifact if job was cancelled
+      with:
+        name: Spellcheck Output
+        path: spellcheck-output.txt

config/.spellcheck.yml

@@ -0,0 +1,16 @@
+matrix:
+- name: Markdown
+  aspell:
+    lang: en
+  dictionary:
+    encoding: utf-8
+  pipeline:
+  - pyspelling.filters.markdown:
+  - pyspelling.filters.html:
+      comments: false
+      ignores:
+      - code
+      - pre
+  sources:
+  - '**/*.md'
+  default_encoding: utf-8