diff --git a/.github/.markdownlint.json b/.github/.markdownlint.json new file mode 100644 index 00000000..6f73e560 --- /dev/null +++ b/.github/.markdownlint.json @@ -0,0 +1,5 @@ +{ + "line-length": false, + "no-inline-html": false, + "no-emphasis-as-heading": false +} diff --git a/.github/workflows/docs-check.yml b/.github/workflows/docs-check.yml new file mode 100644 index 00000000..7fae29cd --- /dev/null +++ b/.github/workflows/docs-check.yml @@ -0,0 +1,31 @@ +name: Markdown Quality Check + +permissions: + contents: read + +on: + push: + branches: [ main ] + pull_request: + branches: [ main ] + +jobs: + markdown-check: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - name: AutoCorrect + uses: huacnlee/autocorrect-action@main + with: + args: doc/**/*.md doc/*.md *.md + + - name: Markdown Lint + uses: DavidAnson/markdownlint-cli2-action@v20 + with: + config: '.github/.markdownlint.json' + fix: false + globs: | + docs/**/*.md + docs/*.md + *.md