Skip to content

Render PlantUML diagrams in Markdown documents #411

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 4 commits into from
Jan 22, 2024
Merged

Render PlantUML diagrams in Markdown documents #411

merged 4 commits into from
Jan 22, 2024

Conversation

dirkgroot
Copy link
Collaborator

@dirkgroot dirkgroot commented Jan 17, 2024 •
edited
Loading

This PR adds support for rendering PlantUML diagrams embedded in documentation files.

ToDo:

  • Support for Markdown
  • Support for Asciidoc

Screenshot:

image

@dirkgroot dirkgroot force-pushed the render-embedded-plantuml-diagrams branch from e95897e to d522b0f Compare January 17, 2024 11:42
@dirkgroot dirkgroot force-pushed the render-embedded-plantuml-diagrams branch from d522b0f to 7c90fcd Compare January 17, 2024 11:43
@dirkgroot
Make FencedCodeBlockRenderer private
3f2a68a 
And move it closer to where it's used.
@dirkgroot dirkgroot marked this pull request as draft January 17, 2024 12:25
@dirkgroot dirkgroot marked this pull request as ready for review January 17, 2024 15:04
@dirkgroot dirkgroot requested a review from jp7677 January 17, 2024 15:05
jp7677
jp7677 suggested changes Jan 17, 2024
View reviewed changes
Copy link
Contributor

@jp7677 jp7677 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code looks good, very cool! Any chance to add a (very) simple test to https://github.com/avisi-cloud/structurizr-site-generatr/blob/main/src/test/kotlin/nl/avisi/structurizr/site/generatr/site/model/MarkdownToHtmlTest.kt and https://github.com/avisi-cloud/structurizr-site-generatr/blob/main/src/test/kotlin/nl/avisi/structurizr/site/generatr/site/model/AsciidocToHtmlTest.kt ?

@dirkgroot
Copy link
Collaborator Author

Code looks good, very cool! Any chance to add a (very) simple test to https://github.com/avisi-cloud/structurizr-site-generatr/blob/main/src/test/kotlin/nl/avisi/structurizr/site/generatr/site/model/MarkdownToHtmlTest.kt and https://github.com/avisi-cloud/structurizr-site-generatr/blob/main/src/test/kotlin/nl/avisi/structurizr/site/generatr/site/model/AsciidocToHtmlTest.kt ?

Thanks! Yes, I was planning on doing so. Didn't expect such a fast review 😄.

@dirkgroot
Copy link
Collaborator Author

@jp7677 I've added the tests.

jp7677
jp7677 suggested changes Jan 19, 2024
View reviewed changes
Copy link
Contributor

@jp7677 jp7677 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a small suggestion (and no strong objections if you want to keep it), otherwise LGTM!

@jp7677 jp7677 merged commit ec7bfb8 into main Jan 22, 2024
@jp7677 jp7677 deleted the render-embedded-plantuml-diagrams branch January 30, 2024 18:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jp7677 jp7677 jp7677 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@dirkgroot @jp7677