thomas-worm/Papyrus Markdown Export
Exports documentation from a Papyrus model. Requires `thomas-worm/setup-papyrus` or pre-exported digram images.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| model-dir | Directory containing the Papyrus model (scanned recursively for *.uml, *.di/*.notation and *.aird files; GMF diagrams need their .di file, matching papyrus-export-diagrams). | no | model |
| start-package | Package to start the export from, as qualified name (e.g. Documentation::arc42, with or without the root model name) or as xmi:id. Empty exports from the model root. | no | "" |
| output-dir | Directory where the markdown tree will be written. Created if missing. | yes | — |
| include-diagrams | If true, diagrams placed directly inside a package are embedded into that package's markdown file (after its comments) unless already referenced there via uml:#. | no | true |
| diagram-format | Image format for diagram exports: SVG, PNG, JPEG, BMP, or GIF. | no | SVG |
| images-subdir | Name of the directory below output-dir where diagram images are placed. | no | images |
| images-dir | Directory with diagram images pre-exported by thomas-worm/papyrus-export-diagrams using naming: xmiId and the same format. When set, the internal diagram export is skipped and papyrus-home is not needed. | no | "" |
| index-file | File name of the markdown file generated per package, e.g. README.md (rendered by GitHub) or index.md (MkDocs convention). | no | README.md |
| add-title | If true, every generated file starts with a `# <package name>` heading. | no | true |
| papyrus-home | Path to the Papyrus-Desktop installation (folder containing the plugins/ directory). Produced by setup-papyrus as papyrus-home. Required unless images-dir is set. | no | "" |
| papyrus-launcher | Path to the Papyrus-Desktop launcher executable. Produced by setup-papyrus as papyrus-launcher. Optional — falls back to searching inside papyrus-home if omitted. | no | "" |
| fail-on-error | If true, the step fails when a diagram fails to export or a uml:# reference cannot be resolved. If false, exports as much as possible and reports warnings. | no | true |
Outputs
| name | description |
|---|---|
| package-count | Number of markdown files generated (one per package). |
| diagram-count | Number of distinct diagram images embedded or referenced in the generated markdown. |