aj-geddes/Sailor Mermaid Processor
Process Mermaid diagrams in markdown files for documentation-as-code pipelines
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Mar 6, 2026
- License
- MIT
Pinned Snippet
uses: aj-geddes/sailor@861dbd3a154e48daa788f6a300d4d114dae751cf # no releases — HEAD as of 2026-07-13tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| source-dir | Directory containing markdown files | no | . |
| output-dir | Directory for generated diagram images | no | diagrams |
| format | Output format (png, svg, pdf) | no | png |
| theme | Mermaid theme (default, dark, forest, neutral) | no | default |
| file-pattern | Pattern for finding markdown files | no | **/*.md |
| commit-changes | Automatically commit generated diagrams | no | true |
| validate-only | Only validate diagrams without generating images | no | false |
| fail-on-error | Fail the action if any diagram has errors | no | true |
| transparent-background | Generate images with transparent background | no | false |
Outputs
| name | description |
|---|---|
| diagrams-processed | Number of diagrams processed |
| diagrams-failed | Number of diagrams that failed |
| output-path | Path to generated diagrams |