diff --git a/.github/workflows/check-markdown.yml b/.github/workflows/check-markdown.yml new file mode 100644 index 0000000..3937f5e --- /dev/null +++ b/.github/workflows/check-markdown.yml @@ -0,0 +1,18 @@ +--- +name: Markdown Syntax Validation + +on: [push, workflow_dispatch] + +jobs: + markdown-check: + + runs-on: ubuntu-latest + steps: + - name: Checkout this repository + uses: actions/checkout@v4.1.0 + + - name: Validate Markdown + uses: DavidAnson/markdownlint-cli2-action@v13.0.0 + with: + config: .markdownlint.json + globs: "**.md" diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 0000000..4a29216 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,12 @@ +{ + "MD013": false, + "MD024": false, + "MD025": false, + "MD033": false, + "MD049": { + "style": "underscore" + }, + "MD050": { + "style": "asterisk" + } +} \ No newline at end of file diff --git a/README.md b/README.md index 97acd11..46acbec 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +