Merge pull request #605 from dorny/docs/markdown_linting

.markdownlint.json

@@ -0,0 +1,13 @@
+{
+  "blanks-around-headings": false,
+  "blanks-around-lists": false,
+  "blanks-around-tables": false,
+  "blanks-around-fences": false,
+  "no-bare-urls": false,
+  "line-length": false,
+  "ul-style": false,
+  "no-inline-html": false,
+  "no-multiple-blanks": {
+    "maximum": 3
+  }
+}

README.md

@@ -9,7 +9,7 @@ This [Github Action](https://github.com/features/actions) displays test results
 ✔️ Provides final `conclusion` and counts of `passed`, `failed` and `skipped` tests as output parameters
 
 **How it looks:**
-|![](assets/fluent-validation-report.png)|![](assets/provider-error-summary.png)|![](assets/provider-error-details.png)|![](assets/mocha-groups.png)|
+|![Summary showing test run with all tests passed, including details such as test file names, number of passed, failed, and skipped tests, and execution times. The interface is dark-themed and displays a green badge indicating 3527 passed and 4 skipped tests.](assets/fluent-validation-report.png)|![Summary showing test run with a failed unit test. The summary uses a dark background and highlights errors in red for quick identification.](assets/provider-error-summary.png)|![GitHub Actions annotation showing details of a failed unit test with a detailed error message, stack trace, and code annotation.](assets/provider-error-details.png)|![Test cases written in Mocha framework with a list of expectations for each test case. The table format and color-coded badges help users quickly assess test suite health.](assets/mocha-groups.png)|
 |:--:|:--:|:--:|:--:|
 
 **Supported languages / frameworks:**

package.json

@@ -81,5 +81,10 @@
   },
   "engines": {
     "node": ">=20"
+  },
+  "markdownlint-cli2": {
+    "ignores": [
+      "__tests__/**/*"
+    ]
   }
 }