diff --git a/.github/workflows/md.yml b/.github/workflows/md.yml new file mode 100644 index 00000000..a54dc1e1 --- /dev/null +++ b/.github/workflows/md.yml @@ -0,0 +1,16 @@ +name: Markdown lint +on: + pull_request: + branches: main +jobs: + markdownlint: + name: markdownlint-cli + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: DavidAnson/markdownlint-cli2-action@v16 + id: linter + with: + globs: 'src/**/*.md' + config: '.markdownlint.jsonc' + fix: true diff --git a/.markdownlint.jsonc b/.markdownlint.jsonc new file mode 100644 index 00000000..2cf7f421 --- /dev/null +++ b/.markdownlint.jsonc @@ -0,0 +1,8 @@ +{ + "MD004": { + "style": "consistent" + }, + "MD034": false, + "MD033": false, + "MD013": false +}