CWL 2 Markdown

CWL to Markdown Transpiler-Mate plugin. It generates one Markdown page per CWL workflow and renders document-level Schema.org SoftwareApplication metadata.

Quick start

Install the plugin and runtime in the same Python environment:

python -m pip install cwl2markdown transpiler-mate-runtime

Generate pages from a metadata-bearing CWL document:

transpiler-mate cwl2markdown --output build/docs workflow.cwl

See the first-steps tutorial for a complete Schema.org metadata example.

Project conventions

This project is templated a Hatch-based Python package with:

• Apache-2.0 license
• Keep a Changelog-compatible CHANGELOG.md
• Diátaxis documentation under docs/
• top-level mkdocs.yaml
• Taskfile integration with Terradue/taskfile-utils
• GitHub Actions CI

Documentation

Project documentation is published at: https://Transpiler-Mate.github.io/cwl2markdown/

Contribute

Submit a Github issue if you have comments or suggestions.

Local quality checks

Install Hatch and Taskfiles then install the Git hook:

task quality:pre-commit:install

Every commit runs Ruff (including the configured McCabe complexity limit), Ruff formatting, strict mypy checks, and the pytest suite.

Run the complete hook explicitly with:

task quality:pre-commit:run

License