search

mrwilson / adr-viewer

Generate easy-to-read web pages for your Architecture Decision Records
MIT License
160 stars 27 forks source link

Adds support for Mermaid diagrams in ADRs #45

Closed colindean closed 1 year ago

colindean commented 1 year ago

Create a codeblock with mermaid as the language tag and it'll render.

See the new test ADR for an example.

mrwilson commented 1 year ago

This looks great! One comment on the versioning of the mermaid JS import.

colindean commented 1 year ago

Ok, looks like the changes are rather large, so I'll have to set aside some time to look at it more closely at some point in the next week or so.

mrwilson commented 1 year ago

No worries at all - any contributions are appreciated. After you've landed it, I'll kick up RC2 with this and the latest changes I've made, then if it all looks good I'll release 1.5.0 soon after that.

colindean commented 1 year ago

I think this is ready to go now. GH is saying This branch cannot be rebased due to conflicts but upstream/master is fully merged into this branch…

mrwilson commented 1 year ago

Yeah, this is rebase problems from my model refactoring.

I've switched the project to allow merge commits temporarily, which GitHub is happy with (I can see the big green "Merge pull request" button), and will fold it in.

Thank you for the change!

colindean commented 1 year ago

Thank you!