markdown lint (#87)

.github/workflows/markdownlint-problem-matcher.json

@@ -0,0 +1,17 @@
+{
+    "problemMatcher": [
+        {
+            "owner": "markdownlint",
+            "pattern": [
+                {
+                    "regexp": "^([^:]*):(\\d+):?(\\d+)?\\s([\\w-\\/]*)\\s(.*)$",
+                    "file": 1,
+                    "line": 2,
+                    "column": 3,
+                    "code": 4,
+                    "message": 5
+                }
+            ]
+        }
+    ]
+}

.github/workflows/markdownlint.yml

@@ -0,0 +1,26 @@
+name: Markdownlint
+
+permissions:
+  contents: read
+
+# run even on changes without markdown changes, so that we can
+# make it in GitHub a required check for PR's
+on:
+  pull_request:
+
+jobs:
+  lint:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Use Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: 16.x
+    - name: Run Markdownlint
+      run: |
+        echo "::add-matcher::.github/workflows/markdownlint-problem-matcher.json"
+        npm i -g markdownlint-cli
+        markdownlint --ignore '.dotnet/' '**/*.md'

.markdownlint.json

@@ -0,0 +1,20 @@
+{
+    "default": true,
+    "ul-indent":                       false,
+    "ul-style":                        false,
+    "no-trailing-spaces":              false,
+    "line-length":                     false,
+    "blanks-around-headings":          false,
+    "no-duplicate-heading":            { "siblings_only": true },
+    "no-trailing-punctuation":         false,
+    "blanks-around-fences":            false,
+    "blanks-around-lists":             false,
+    "no-inline-html":                  { "allowed_elements": [ "summary", "details", "kbd", "br" ]},
+    "no-bare-urls":                    false,
+    "single-trailing-newline":         false,
+    "emphasis-style":                  false,
+
+    // rule settings and options are documented in https://github.com/DavidAnson/markdownlint
+    // feel free to disable more low value rules in here; get rule name from the error message.
+    // the purpose of the linter is to catch significant issues like broken links.
+}

.markdownlintignore

@@ -0,0 +1,2 @@
+# This is for editors; keep .github/workflows/markdownlint.yml in sync
+.dotnet/

README.md

@@ -30,16 +30,16 @@ dotnet restore eShop.Web.slnf
 > Remember to ensure that Docker is started
 
 * (Windows only) Run the application from Visual Studio:
-	* Open the `eShop.Web.slnf` file in Visual Studio
-	* Ensure that `eShop.AppHost.csproj` is your startup project
-	* Hit Ctrl-F5 to launch Aspire
+ - Open the `eShop.Web.slnf` file in Visual Studio
+ - Ensure that `eShop.AppHost.csproj` is your startup project
+ - Hit Ctrl-F5 to launch Aspire
 
 * Or run the application from your terminal:
 ```powershell
 dotnet run --project src/eShop.AppHost/eShop.AppHost.csproj
 ```
 then look for lines like this in the console output in order to find the URL to open the Aspire dashboard:
-```
+```sh
 Now listening on: http://localhost:18848
 ```