diff --git a/.github/workflows/markdown-lint.yml b/.github/workflows/markdown-lint.yml new file mode 100644 index 0000000..b3e9f62 --- /dev/null +++ b/.github/workflows/markdown-lint.yml @@ -0,0 +1,26 @@ +name: Markdown Lint + +on: + push: + branches: + - main + pull_request: + +jobs: + markdown-lint: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + - name: Set up Node.js environment + uses: actions/setup-node@v2 + with: + node-version: '16' # Upgrade to Node.js version 16 + + - name: Install markdownlint-cli + run: npm install -g markdownlint-cli + + - name: Run markdownlint on markdown files + run: markdownlint '**/*.md' diff --git a/.github/workflows/spell-check.yml b/.github/workflows/spell-check.yml new file mode 100644 index 0000000..45a8060 --- /dev/null +++ b/.github/workflows/spell-check.yml @@ -0,0 +1,24 @@ +name: Spell Check + +on: + push: + branches: + - main + pull_request: + +jobs: + spell-check: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + - name: Install aspell + run: sudo apt-get install -y aspell aspell-en + + - name: Install pyspelling + run: pip install pyspelling + + - name: Run Spell Checker + run: pyspelling -c spellcheck.yaml diff --git a/spellcheck.yaml b/spellcheck.yaml new file mode 100644 index 0000000..7718ff5 --- /dev/null +++ b/spellcheck.yaml @@ -0,0 +1,16 @@ +# spellcheck.yaml + +matrix: + - name: Markdown Files + sources: + - '**/*.md' # Check all markdown files in the repository + dictionary: + # Use the default language dictionary (no need for a list of dictionaries) + language: en_US # Specify the language + # List of custom words to exclude (e.g., technical terms, proper names) + ignore_words: + - GitHub + - markdownlint + - pyspelling + - CI + - lint \ No newline at end of file