chore: add markdown lint check for markdown files on push and pull request (#497)

* chore: add markdown lint check for markdown files on push and pull request

* Update .github/workflows/markdownlint.yml

Co-authored-by: Copilot <[email protected]>

* Update .github/workflows/markdownlint.yml

Co-authored-by: Copilot <[email protected]>

* Update .github/workflows/markdownlint.yml

Co-authored-by: Copilot <[email protected]>

* Update .github/workflows/markdownlint.yml

Co-authored-by: Copilot <[email protected]>

* Update .github/workflows/markdownlint.yml

Co-authored-by: Copilot <[email protected]>

---------

Co-authored-by: Copilot <[email protected]>

Author: alaahong

.github/workflows/markdownlint.yml

@@ -0,0 +1,59 @@
+name: Markdown Lint
+
+on:
+  pull_request:
+    paths:
+      - '**/*.md'
+  push:
+    paths:
+      - '**/*.md'
+
+jobs:
+  markdownlint:
+    if: github.event_name == 'push' || github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Install markdownlint-cli2
+        run: npm install -g markdownlint-cli2
+
+      - name: Run markdownlint
+        id: lint
+        run: |
+          if [ "${{ github.event_name }}" = "pull_request" ]; then
+            CHANGED_MD=$(git diff --name-only origin/${{ github.event.pull_request.base.ref }}...${{ github.event.pull_request.head.ref }} | grep -E '\.md$' || true)
+          else
+            CHANGED_MD=$(git diff-tree --no-commit-id --name-only -r ${{ github.sha }} | grep -E '\.md$' || true)
+          fi
+          if [ -n "$CHANGED_MD" ]; then
+            markdownlint-cli2 "$CHANGED_MD" --config website/.markdownlint-cli2.jsonc > lint-result.txt || true
+            if [ -s lint-result.txt ]; then
+              echo "Lint failed."
+              # Output non-compliant file contents to comment-body.txt
+              for file in $CHANGED_MD; do
+                echo "\n---\n**$file Content:**\n" >> comment-body.txt
+                echo '\n```markdown' >> comment-body.txt
+                cat "$file" >> comment-body.txt
+                echo '\n```' >> comment-body.txt
+              done
+              echo "\n---\n**Lint Results:**\n" >> comment-body.txt
+              cat lint-result.txt >> comment-body.txt
+              exit 1
+            fi
+          else
+            echo "No markdown files changed, skipping lint."
+          fi
+      - name: Create PR comment with lint result
+        if: failure() && steps.lint.conclusion == 'failure' && github.event_name == 'pull_request'
+        uses: peter-evans/create-or-update-comment@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          issue-number: ${{ github.event.pull_request.number }}
+          body-file: comment-body.txt