skitionek/nf-mapper

Convert a Nextflow pipeline (.nf) into a Mermaid gitGraph diagram

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
pipelinePath to the Nextflow pipeline file (.nf) to convertyes
outputPath where the Mermaid diagram will be written (default: diagram.md). Ignored when 'update' is set.nodiagram.md
titleOptional diagram titleno""
formatOutput format: 'plain' (raw Mermaid) or 'md' (fenced code block) (default: md)nomd
rendererRenderer strategy: 'default' or 'conditional' (default: default)nodefault
themeTheme class: 'nf-core' or 'plain' (default: nf-core)nonf-core
configJSON object of Mermaid gitGraph config overrides, e.g. '{"showBranches": true}'. Merged with defaults: showBranches=true, parallelCommits=false.no""
updatePath 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""
markerMarker 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 -->.nonf-mapper
namedescription
diagramPath to the generated or updated Mermaid diagram file