diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 46623c732..8dbe10877 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -36,4 +36,11 @@ jobs: - name: Lint workflows uses: docker://rhysd/actionlint@sha256:89d3f90f82781dee3c8724651129634b08cf2241bbd67fcd02a1c5198119fc5e # v1.7.2 with: - args: -color + args: -color + + - name: Lint markdown + uses: DavidAnson/markdownlint-cli2-action@v17 + with: + config: '.markdownlint.json' + globs: | + **/*.md diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 000000000..e8272ec39 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,4 @@ +{ + "MD013": false, + "MD040": false +} diff --git a/.vscode/extensions.json b/.vscode/extensions.json index 6d388e625..f4c71cdfb 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -1,5 +1,6 @@ { "recommendations": [ + "davidanson.vscode-markdownlint", "editorconfig.editorconfig", "github.vscode-github-actions", "ms-dotnettools.csharp", diff --git a/README.md b/README.md index a91eee6dc..5cc4864d4 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Any feedback or issues can be added to the issues for this project in [GitHub](h ## Repository -The repository is hosted in [GitHub](https://github.com/martincostello/api): [https://github.com/martincostello/api.git](https://github.com/martincostello/api.git) +The repository is hosted in [GitHub](https://github.com/martincostello/api): ## License