Skip to content

UML diagrams added #80

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

UML diagrams added #80

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/PlutoUI.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ include("./Resource.jl")
include("./Terminal.jl")
include("./RangeSlider.jl")
include("./DisplayTricks.jl")
include("./UML.jl")

@reexport module TableOfContentsNotebook
include("./TableOfContents.jl")
Expand Down
34 changes: 34 additions & 0 deletions src/UML.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
export UML

"""
Creates an UML diagram using [Mermaid.js](https://mermaid-js.github.io/mermaid/#/)

Diagrams are specified using Markdown code following the syntax described [here](https://mermaid-js.github.io/mermaid/#/).

Example:

UML(\"\"\"
graph LR
A --- B
B-->C[fa:fa-ban forbidden]
B-->D(fa:fa-spinner)
B-->E-->F---G
\"\"\")
"""
struct UML
code:: String
end

function show(io::IO, ::MIME"text/html", uml::UML)
print(io, """
<!DOCTYPE html>
<body>
<div class="mermaid">
$(uml.code)
</div>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/mermaid.min.js"></script>
<script>mermaid.initialize({startOnLoad:true});</script>
</body>
</html>
""")
end