Skip to content

Add markdown output mode for Mermaid diagrams#56

Merged
mitchspano merged 3 commits intomainfrom
markdown_output
Aug 21, 2025
Merged

Add markdown output mode for Mermaid diagrams#56
mitchspano merged 3 commits intomainfrom
markdown_output

Conversation

@mitchspano
Copy link
Collaborator

  • New markdown mode that generates .md files with Mermaid diagrams
  • Mode restricted to Mermaid diagram tool only
  • Output files named after flow API names in specified output directory

- Introduce MARKDOWN mode in ArgumentProcessor, including validation for output directory and diagram tool requirements.
- Implement UML diagram writing functionality for MARKDOWN mode in UmlWriter, generating markdown files with appropriate content.
- Enhance tests in argument_processor_test and uml_writer_test to cover new MARKDOWN mode scenarios, ensuring correct validation and output generation.
- Increment package version in deno.json.
- Update README.md to reflect the addition of 'markdown' as an output mode alongside 'json' and 'github_action', including detailed descriptions and examples for each mode.
- Remove outdated images related to UML diagram differences from the docs/img directory.
@mitchspano mitchspano merged commit 28cd7b3 into main Aug 21, 2025
2 checks passed
@mitchspano mitchspano deleted the markdown_output branch August 21, 2025 15:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant