Gandalf/sofarr
1
0
Fork 0
Code Issues 1 Pull Requests Actions 1 Packages Projects Releases 15 Wiki Activity

ci: add separate docs-check workflow for Markdown lint and Mermaid parse validation
Some checks failed
CI / Security audit (push) Has been cancelled
Details
CI / Tests & coverage (push) Has been cancelled
Details
Docs Check / Markdown lint (push) Has been cancelled
Details
Docs Check / Mermaid diagram parse check (push) Has been cancelled
Details
Build and Push Docker Image / build (push) Has been cancelled
Details

Browse Source 
- docs-check.yml runs on push/PR only when .md files change
- markdown-lint job: uses markdownlint-cli to check all .md files
- mermaid-parse job: extracts all mermaid blocks from .md files and
  validates each via mmdc (mermaid-js CLI) in headless Chromium
- Both jobs use continue-on-error: true so docs failures never block
  a release or fail the main CI pipeline
- .markdownlint.json disables MD013 (line length), MD033 (inline HTML),
  MD041 (first-line heading) to reduce noise on this repo
This commit is contained in:
Gronod
2026-05-17 18:36:16 +01:00
parent 2cf163dfff
commit a368636ec4
2 changed files with 115 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
.markdownlint.json Normal file
View File

@@ -0,0 +1,6 @@
{
"default": true,
"MD013": false,
"MD033": false,
"MD041": false
}