Skip to content
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.

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

Replace diagrams with mermaid.js #188

Merged
merged 4 commits into from
Jan 17, 2023
Merged

Replace diagrams with mermaid.js #188

merged 4 commits into from
Jan 17, 2023

Conversation

martialblog
Copy link
Member

@martialblog martialblog commented Jan 11, 2023

Diagrams are now rendered with mermaid.js - with this change we can now more easily modify them in the future.

All diagrams can be written in mermaid and then be rendered with the mermaid-cli

cat _images/mermaid/central-vcs.mmd
graph RL
    subgraph CentralVCS
    C{{Version DB}}
    end
    C -->|Client A| D[File]
    C -->|Client B| E[File]
    C -->|Client C| F[File]

# Can also render svg
docker run -u `id -u`:`id -g` --rm -v $(pwd)/_images/mermaid:/data minlag/mermaid-cli -e png -i "/data/central-vcs.mmd"

Fixes #36

@martialblog martialblog added this to the 3.0.0 milestone Jan 11, 2023
@martialblog martialblog self-assigned this Jan 11, 2023
@martialblog
Copy link
Member Author

@theFeu @htriem @mocdaniel I'd love some feedback on this. 📈

@martialblog
Copy link
Member Author

I tried the showoff mermaid support with @@@render-diagram however, I wasn't able to get the diagrams to render in the correct size. I might be able to refactor that later though.

@martialblog martialblog changed the title [Work in Progress] Replace diagrams with mermaid.js Replace diagrams with mermaid.js Jan 11, 2023
@martialblog martialblog marked this pull request as ready for review January 11, 2023 13:59
@theFeu
Copy link
Collaborator

theFeu commented Jan 12, 2023

as discussed offline
@martialblog will still update the gitflow workflow graphics so the colours match

@martialblog
Copy link
Member Author

@theFeu I updated the images so that the colors stay the same.

@theFeu
Copy link
Collaborator

theFeu commented Jan 12, 2023

I'll assume you looked at it and would say it's ready to merge then!

Actually!
We could maybe scale the images for the Gitflow so that they are the same size and don't jump around anymore.
What do you think @martialblog ?

@martialblog
Copy link
Member Author

I will give it a try

@theFeu
Copy link
Collaborator

theFeu commented Jan 12, 2023

If you want to, you can leave it to me, I have the right tools.
I'd do it tomorrow at lunch.

@martialblog
Copy link
Member Author

I added some adjustments on a new commit

@martialblog
Copy link
Member Author

@theFeu I'm waiting on your go to shipit :shipit:

@theFeu
Copy link
Collaborator

theFeu commented Jan 17, 2023

GOGO

@martialblog
Copy link
Member Author

Houston we are go for merge 🚀

@martialblog martialblog merged commit cef85a9 into master Jan 17, 2023
@martialblog martialblog deleted the update-images branch January 17, 2023 15:12
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.

Redraw all explanations for a more uniform look
2 participants