Add markdownlint

Add a Markdown linter.
martincostello · Sep 28, 2024 · 440ef0e · 440ef0e
1 parent 556c70e
commit 440ef0e
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 2 deletions.
diff --git 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
@@ -0,0 +1,4 @@
+{
+  "MD013": false,
+  "MD040": false
+}
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -1,6 +1,8 @@
 {
   "recommendations": [
+    "davidanson.vscode-markdownlint",
     "editorconfig.editorconfig",
+    "github.vscode-github-actions",
     "ms-dotnettools.csharp",
     "ms-vscode.PowerShell"
   ]

diff --git a/README.md b/README.md
@@ -12,7 +12,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/project-euler): https://github.com/martincostello/project-euler.git
+The repository is hosted in [GitHub](https://github.com/martincostello/project-euler): <https://github.com/martincostello/project-euler.git>
 
 ## License