experimental: markdown lint in CI

.github/workflows/TODO.md

@@ -0,0 +1,5 @@
+Evaluate:
+
+* misspell
+* spellcheck
+* govulncheck

.github/workflows/markdown.yml

@@ -0,0 +1,36 @@
+name: Markdown
+
+on:
+  pull_request_target:
+    paths:
+    - '**/*.md'
+
+permissions:
+  pull-requests: write
+  contents: read
+
+jobs:
+  lint-markdown:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout Repo
+      uses: actions/checkout@v4
+
+    - name: Run markdown linter
+      id: markdownlint
+      #continue-on-error: true
+      uses: docker://avtodev/markdown-lint:v1
+      with:
+        config: .markdownlint.yml
+        args: '**/*.md'
+        output: ./markdownlint.txt
+
+    - name: Create PR comment
+      if: ${{ failure() && steps.markdownlint.outcome == 'failure' }}
+      #if: steps.markdownlint.outputs.exit_code != 0
+      uses: peter-evans/create-or-update-comment@v4
+      with:
+        issue-number: ${{ github.event.pull_request.number }}
+        title: Markdown Lint Report
+        body-path: ./markdownlint.txt
+        labels: report, bot-generated

.markdownlint.yml

@@ -0,0 +1,28 @@
+# Default state for all rules
+default: true
+
+# ul-style
+MD004: false
+
+# hard-tabs
+MD010: false
+
+# line-length
+MD013: false
+
+# no-duplicate-header
+MD024:
+  siblings_only: true
+
+#single-title
+MD025: false
+
+# ol-prefix
+MD029:
+  style: ordered
+
+# no-inline-html
+MD033: false
+
+# fenced-code-language
+MD040: false

README.md

@@ -6,3 +6,6 @@
 [![Go Report Card](https://goreportcard.com/badge/github.com/go-openapi/errors)](https://goreportcard.com/report/github.com/go-openapi/errors)
 
 Shared errors and error interface used throughout the various libraries found in the go-openapi toolkit.
+
+
+# blah blah