Merge pull request #77 from xt0rted/markdown

Add markdownlint

Author: xt0rted

.github/workflows/ci.yml

@@ -15,6 +15,24 @@ env:
   CONFIGURATION: Release
 
 jobs:
+  lint-markdown:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/[email protected]
+
+      - name: Install Node
+        uses: actions/[email protected]
+        with:
+          node-version: 18
+
+      - uses: xt0rted/[email protected]
+
+      - run: npm ci
+
+      - run: npm test
+
   build:
     runs-on: ${{ matrix.os }}
 
@@ -73,7 +91,9 @@ jobs:
           path: ./coverage/*.trx
 
   integration:
-    needs: build
+    needs:
+      - build
+      - lint-markdown
 
     runs-on: ${{ matrix.os }}
 

.markdownlint.json

@@ -1,4 +1,5 @@
 {
   "MD013": false,
-  "MD024": false
+  "MD024": false,
+  "MD033": false
 }

README.md

@@ -27,7 +27,7 @@ dotnet tool install run-script
 
 ## Keeping current
 
-Tools like [Dependabot](https://github.com/apps/dependabot) (https://github.com/github/feedback/discussions/13825) and [Renovate](https://github.com/marketplace/renovate) don't currently support updating dotnet local tools.
+Tools like [Dependabot](https://github.com/github/feedback/discussions/13825) and [Renovate](https://github.com/marketplace/renovate) don't currently support updating dotnet local tools.
 One way to automate this is to use a [GitHub Actions workflow](https://github.com/xt0rted/dotnet-tool-update-test) to check for updates and create PRs when new versions are available, which is what this repo does.
 
 ## Options

docs/README.md

@@ -34,7 +34,7 @@ Or code coverage can be collected by calling:
 > dotnet r test:coverage
 ```
 
-### What this isn't
+## What this isn't
 
 This tool is not a replacement for a more robust build tool like [Cake](https://cakebuild.net/) or [Fake](https://fake.build/).
 Instead it's meant to be used as a way to more easily call them by defining a common set of commands like `clean`, `build`, `test`, `package`, or `publish` that can be added to all of your projects without the user knowing, or caring, how they work or what they do.