skitionek/nf-mapper
Convert a Nextflow pipeline (.nf) into a Mermaid gitGraph diagram
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| pipeline | Path to the Nextflow pipeline file (.nf) to convert | yes | — |
| output | Path where the Mermaid diagram will be written (default: diagram.md). Ignored when 'update' is set. | no | diagram.md |
| title | Optional diagram title | no | "" |
| format | Output format: 'plain' (raw Mermaid) or 'md' (fenced code block) (default: md) | no | md |
| renderer | Renderer strategy: 'default' or 'conditional' (default: default) | no | default |
| theme | Theme class: 'nf-core' or 'plain' (default: nf-core) | no | nf-core |
| config | JSON object of Mermaid gitGraph config overrides, e.g. '{"showBranches": true}'. Merged with defaults: showBranches=true, parallelCommits=false. | no | "" |
| update | Path to an existing Markdown file containing <!-- MARKER --> / <!-- /MARKER --> comment blocks. When set, the matching block is updated in-place instead of writing a new file. | no | "" |
| marker | Marker name identifying which comment block to update (default: nf-mapper). Use a unique name per diagram when a file contains multiple nf-mapper blocks, e.g. 'main-pipeline' targets <!-- main-pipeline --> / <!-- /main-pipeline -->. | no | nf-mapper |
Outputs
| name | description |
|---|---|
| diagram | Path to the generated or updated Mermaid diagram file |