2021-10-16 23:18:04 +00:00
<!doctype html> < html lang = en class = "js csstransforms3d" >
< head >
< meta charset = utf-8 >
< meta name = viewport content = "width=device-width,initial-scale=1" >
< meta name = generator content = "Hugo 0.88.1" >
< meta name = description content = "Generation of diagram and flowchart from text in a similar manner as Markdown" >
< meta name = author content = "Sören Weber" >
2021-10-19 15:26:14 +00:00
< link rel = "shortcut icon" href = ../../images/logo.svg?1634657171 >
2021-10-16 23:18:04 +00:00
< title > Mermaid :: Documentation for Hugo Relearn Theme< / title >
2021-10-19 15:26:14 +00:00
< link href = ../../css/nucleus.css?1634657171 rel = stylesheet >
< link href = ../../css/fontawesome-all.min.css?1634657171 rel = stylesheet >
< link href = ../../css/featherlight.min.css?1634657171 rel = stylesheet >
< link href = ../../css/perfect-scrollbar.min.css?1634657171 rel = stylesheet >
< link href = ../../css/auto-complete.css?1634657171 rel = stylesheet >
< link href = ../../css/theme.css?1634657171 rel = stylesheet >
< link href = ../../css/theme-relearn.css?1634657171 rel = stylesheet >
< link href = ../../css/variant.css?1634657171 rel = stylesheet >
< link href = ../../css/print.css?1634657171 rel = stylesheet media = print >
< script src = ../../js/jquery.min.js?1634657171 > < / script >
2021-10-16 23:18:04 +00:00
< style > : root # header + # content > # left > # rlblock_left { display : none !important } < / style >
< / head >
2021-10-17 21:04:12 +00:00
< body data-url = ../../shortcodes/mermaid/ >
2021-10-16 23:18:04 +00:00
< nav id = sidebar class = showVisitedLinks >
< div id = header-wrapper >
< div id = header >
2021-10-17 21:04:12 +00:00
< a id = logo href = ../../ style = "color:#3d414d;font-family:novacento sans wide,helvetica,tahoma,geneva,arial,sans-serif;font-size:30px;font-weight:700;margin-top:-2px" > < svg xmlns = "http://www.w3.org/2000/svg" viewBox = "0 0 64.044 64.044" style = "height:65px;margin-bottom:-20px;margin-top:-20px;width:65px" > < path d = "M46.103 136.34c-.642-.394-1.222-2.242-1.98-2.358-.76-.117-1.353.506-1.618 1.519-.266 1.012-.446 4.188.173 5.538.213.435.482.787 1.03.845.547.057.967-.504 1.45-1.027.482-.523.437-.9 1.142-.612.705.289 1.051.4 1.586 1.229.535.828 1.085 4.043.868 5.598-.241 1.458-.531 2.8-.59 4.088.26.075.517.148.772.217 2.68.724 5.373 1.037 7.873.02.001-.028.01-.105.008-.11-.048-.165-.18-.41-.36-.698-.18-.29-.414-.645-.586-1.114a3.212 3.212.0 01-.125-1.735c.056-.21.153-.342.249-.475 1.237-1.193 2.932-1.373 4.244-1.384.557-.004 1.389.016 2.198.255s1.706.724 2.068 1.843c.187.578.114 1.17-.043 1.623-.153.438-.369.783-.545 1.091-.178.31-.329.6-.401.821-.007.02-.003.071-.005.094 2.256 1.008 4.716.91 7.189.398.55-.114 1.11-.247 1.673-.377.344-1.085.678-2.145.852-3.208.124-.752.158-2.311-.078-3.538-.118-.613-.306-1.15-.52-1.489-.221-.349-.413-.501-.747-.538-.243-.027-.51.013-.796.098-.67.223-1.33.606-1.966.76l-.008.002-.109.032c-.556.152-1.233.158-1.797-.36-.556-.51-.89-1.367-1.117-2.596-.283-1.528-.075-3.279.89-4.518l.071-.09h.07c.65-.71 1.485-.802 2.16-.599.706.213 1.333.629 1.772.84.736.354 1.185.319 1.475.171.291-.148.5-.439.668-.955.332-1.017.301-2.819.022-4.106-.148-.684-.13-1.292-.13-1.883-1.558-.463-3.067-.982-4.574-1.208-1.128-.169-2.263-.173-3.298.164-.13.046-.256.095-.38.15-.373.164-.633.342-.805.52-.077.098-.081.105-.087.21-.004.068.031.289.13.571.1.282.256.634.467 1.03.279.524.448 1.063.431 1.618a2.12 2.12.0 01-.499 1.309 1.757 1.757.0 01-.62.51h-.002c-.515.291-1.107.404-1.723.464-.86.083-1.787.026-2.598-.097-.806-.123-1.47-.28-1.948-.555-.444-.256-.79-.547-1.037-.925a2.273 2.273.0 01-.356-1.301c.029-.837.403-1.437.625-1.897.111-.23.191-.433.236-.583.045-.15.044-.25.046-.24-.005-.029-.127-.355-1.015-.741-1.138-.495-2.322-.673-3.533-.668h-.015a9.711 9.711.0 00-.521.016h-.002c-1.163.057-2.35.308-3.541.569.383 1.531.79 2.753.818 4.502-.096 1.297.158 2.114-1.03 2.935-.85.588-1.508.729-2.15.335" style = "fill:#3d414d;fill-opacity:1;stroke:none;stroke-width:1.03763;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" transform = "translate(-40.698 -95.175)" / > < path d = "M61.472 101.34v.002c-.3-.003-.603.01-.894.04-.544.055-1.39.165-1.778.306-1.238.364.13 2.344.41 2.913.28.569.285 2.03.14 2.134-.144.103-.375.261-.934.345-.56.084.03-.037-1.589.086-1.62.122-5.506.29-8.265.248-.022.26-.036.521-.097.808-.309 1.442-.63 3.163-.494 4.074.071.473.168.65.414.8.23.14.737.235 1.62-.004.834-.227 1.3-.442 1.887-.456.595-.016 1.555.472 1.965.717.411.245-.03-.008.002.0s.128.05.176.102c.049.053-.276-.523.104.199.379.721.72 3.256.002 4.68-.46.913-1.01 1.49-1.64 1.711-.63.22-1.229.067-1.734-.135-.881-.353-1.584-.7-2.205-.647-1.199 1.94-1.186 4.17-.6 6.602.097.397.212.814.327 1.23 2.68-.556 5.542-1.016 8.337.132 1.064.437 1.73 1.015 1.902 1.857.169.831-.193 1.508-.438 1.986-.122.238-.23.46-.307.642-.07.164-.096.28-.104.324.069.429.309.723.686.945.385.227.89.355 1.35.423.723.104 1.567.152 2.287.086.693-.064 1.032-.338 1.241-.544a2.447 2.447.0 00.303-.437.175.175.0 00.013-.035c-.004-.066-.037-.246-.195-.527-.46-.816-.87-1.595-.817-2.51.028-.476.218-.938.529-1.288.304-.343.698-.586 1.186-.79 1.442-.606 2.96-.609 4.372-.409 1.525.216 2.963.679 4.378 1.083.226-2.09.784-3.9.592-5.77-.058-.565-.287-1.333-.598-1.827-.32-.508-.59-.717-1.036-.642-.648.11-1.472.935-2.707 1.078-.791.092-1.494-.267-1.95-.86-.45-.583-.678-1.335-.78-2.101-.202-1.525.031-3.229.89-4.27.615-.747 1.45-.887 2.15-.74.687.145 1.307.492 1.857.745v-.002c.546.252 1.033.388 1.281.344a.547.547.0 00.353-.188c.113-.124.242-.35.384-.75.604-1.712.206-3.68-.303-5.654-.667.145-1.336.293-2.018.413-1.341.236-2.73.392-4.136.273-.656-.055-1.695-.085-2.58-.476-.442-.195-.903-.514-1.157-1.093-.259-.591-.205-1.313.08-2.014.223-.64 1.082-2.178.692-2.585-.391-.407-1.651-.56-2.554-.571z" style = "fill:#3d414d;fill-
2021-10-16 23:18:04 +00:00
Relearn
< / a >
< / div >
< div class = searchbox >
< label for = search-by > < i class = "fas fa-search" > < / i > < / label >
< input data-search-input id = search-by type = search placeholder = Search... >
< span data-search-clear > < i class = "fas fa-times" > < / i > < / span >
< / div >
2021-10-19 15:26:14 +00:00
< script src = ../../js/lunr.min.js?1634657171 > < / script >
< script src = ../../js/auto-complete.js?1634657171 > < / script >
2021-10-17 21:04:12 +00:00
< script > var index _url = "../../index.json" , root _url = "../../" , baseUri = root _url . replace ( /\/$/ , '' ) < / script >
2021-10-19 15:26:14 +00:00
< script src = ../../js/search.js?1634657171 > < / script >
2021-10-16 23:18:04 +00:00
< / div >
< div class = highlightable >
< ul class = topics >
2021-10-17 21:04:12 +00:00
< li data-nav-id = /basics/ title = Basics class = dd-item > < a href = ../../basics/ > < b > 1.< / b > Basics< i class = "fas fa-check read-icon" > < / i > < / a > < ul >
< li data-nav-id = /basics/migration/ title = "What's new" class = "dd-item alwaysopen" > < a href = ../../basics/migration/ > What's new< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li >
< li data-nav-id = /basics/requirements/ title = Requirements class = "dd-item alwaysopen" > < a href = ../../basics/requirements/ > Requirements< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li >
< li data-nav-id = /basics/installation/ title = Installation class = "dd-item alwaysopen" > < a href = ../../basics/installation/ > Installation< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li >
< li data-nav-id = /basics/configuration/ title = Configuration class = "dd-item alwaysopen" > < a href = ../../basics/configuration/ > Configuration< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li >
< li data-nav-id = /basics/customization/ title = Customization class = "dd-item alwaysopen" > < a href = ../../basics/customization/ > Customization< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li >
< li data-nav-id = /basics/history/ title = History class = "dd-item alwaysopen" > < a href = ../../basics/history/ > History< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li > < / ul > < / li >
< li data-nav-id = /cont/ title = Content class = dd-item > < a href = ../../cont/ > < b > 2.< / b > Content< i class = "fas fa-check read-icon" > < / i > < / a > < ul >
< li data-nav-id = /cont/pages/ title = "Pages organization" class = "dd-item alwaysopen" > < a href = ../../cont/pages/ > Pages organization< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li >
< li data-nav-id = /cont/archetypes/ title = Archetypes class = dd-item > < a href = ../../cont/archetypes/ > Archetypes< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /cont/markdown/ title = "Markdown syntax" class = dd-item > < a href = ../../cont/markdown/ > Markdown syntax< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /cont/syntaxhighlight/ title = "Code highlighting" class = dd-item > < a href = ../../cont/syntaxhighlight/ > Code highlighting< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /cont/menushortcuts/ title = "Menu extra shortcuts" class = dd-item > < a href = ../../cont/menushortcuts/ > Menu extra shortcuts< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /cont/icons/ title = "Icons and logos" class = dd-item > < a href = ../../cont/icons/ > Icons and logos< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /cont/i18n/ title = "Multilingual and i18n" class = "dd-item alwaysopen" > < a href = ../../cont/i18n/ > Multilingual and i18n< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li >
< li data-nav-id = /cont/tags/ title = Tags class = dd-item > < a href = ../../cont/tags/ > Tags< i class = "fas fa-check read-icon" > < / i > < / a > < / li > < / ul > < / li >
< li data-nav-id = /shortcodes/ title = Shortcodes class = "dd-item parent" > < a href = ../../shortcodes/ > < b > 3.< / b > Shortcodes< i class = "fas fa-check read-icon" > < / i > < / a > < ul >
< li data-nav-id = /shortcodes/attachments/ title = Attachments class = dd-item > < a href = ../../shortcodes/attachments/ > Attachments< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /shortcodes/button/ title = Button class = dd-item > < a href = ../../shortcodes/button/ > Button< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /shortcodes/children/ title = Children class = dd-item > < a href = ../../shortcodes/children/ > Children< i class = "fas fa-check read-icon" > < / i > < / a > < ul >
< li data-nav-id = /shortcodes/children/test/ title = "page X" class = dd-item > < a href = ../../shortcodes/children/test/ > page X< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /shortcodes/children/children-1/ title = "page 1" class = dd-item > < a href = ../../shortcodes/children/children-1/ > page 1< i class = "fas fa-check read-icon" > < / i > < / a > < ul >
< li data-nav-id = /shortcodes/children/children-1/children-1-1/ title = "page 1-1" class = dd-item > < a href = ../../shortcodes/children/children-1/children-1-1/ > page 1-1< i class = "fas fa-check read-icon" > < / i > < / a > < ul >
< li data-nav-id = /shortcodes/children/children-1/children-1-1/children-1-1-2/ title = "page 1-1-2" class = "dd-item alwaysopen" > < a href = ../../shortcodes/children/children-1/children-1-1/children-1-1-2/ > page 1-1-2< i class = "fas fa-check read-icon" > < / i > < / a > < ul >
< li data-nav-id = /shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/ title = "page 1-1-2-1" class = "dd-item alwaysopen" > < a href = ../../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/ > page 1-1-2-1< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li >
< li data-nav-id = /shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/ title = "page 1-1-2-2" class = "dd-item alwaysopen" > < a href = ../../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/ > page 1-1-2-2< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li > < / ul > < / li >
< li data-nav-id = /shortcodes/children/children-1/children-1-1/children-1-1-3/ title = "page 1-1-3" class = "dd-item alwaysopen" > < a href = ../../shortcodes/children/children-1/children-1-1/children-1-1-3/ > page 1-1-3< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li > < / ul > < / li > < / ul > < / li >
< li data-nav-id = /shortcodes/children/children-2/ title = "page 2" class = dd-item > < a href = ../../shortcodes/children/children-2/ > page 2< i class = "fas fa-check read-icon" > < / i > < / a > < ul > < / ul > < / li >
< li data-nav-id = /shortcodes/children/children-3/ title = "page 3" class = dd-item > < a href = ../../shortcodes/children/children-3/ > page 3< i class = "fas fa-check read-icon" > < / i > < / a > < ul >
< li data-nav-id = /shortcodes/children/children-3/test3/ title = "page 3-1" class = dd-item > < a href = ../../shortcodes/children/children-3/test3/ > page 3-1< i class = "fas fa-check read-icon" > < / i > < / a > < / li > < / ul > < / li > < / ul > < / li >
< li data-nav-id = /shortcodes/expand/ title = Expand class = dd-item > < a href = ../../shortcodes/expand/ > Expand< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /shortcodes/include/ title = Include class = dd-item > < a href = ../../shortcodes/include/ > Include< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /shortcodes/mermaid/ title = Mermaid class = "dd-item active" > < a href = ../../shortcodes/mermaid/ > Mermaid< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /shortcodes/notice/ title = Notice class = dd-item > < a href = ../../shortcodes/notice/ > Notice< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /shortcodes/siteparam/ title = "Site param" class = dd-item > < a href = ../../shortcodes/siteparam/ > Site param< i class = "fas fa-check read-icon" > < / i > < / a > < / li >
< li data-nav-id = /shortcodes/tabs/ title = "Tabbed views" class = dd-item > < a href = ../../shortcodes/tabs/ > Tabbed views< i class = "fas fa-check read-icon" > < / i > < / a > < / li > < / ul > < / li >
2021-10-16 23:18:04 +00:00
< / ul >
< div id = shortcuts >
< div class = nav-title > More< / div >
< ul >
2021-10-17 21:04:12 +00:00
< li > < a class = padding href = ../../tags/ > < i class = "fas fa-fw fa-tags" > < / i > Tags< / a > < / li >
2021-10-16 23:18:04 +00:00
< li > < a class = padding href = https://github.com/McShelby/hugo-theme-relearn > < i class = "fab fa-fw fa-github" > < / i > GitHub repo< / a > < / li >
2021-10-17 21:04:12 +00:00
< li > < a class = padding href = ../../showcase/ > < i class = "fas fa-fw fa-camera" > < / i > Showcases< / a > < / li >
2021-10-16 23:18:04 +00:00
< li > < a class = padding href = https://gohugo.io/ > < i class = "fas fa-fw fa-bookmark" > < / i > Hugo Documentation< / a > < / li >
2021-10-17 21:04:12 +00:00
< li > < a class = padding href = ../../credits/ > < i class = "fas fa-fw fa-bullhorn" > < / i > Credits< / a > < / li >
2021-10-16 23:18:04 +00:00
< / ul >
< / div >
< div id = prefooter >
< hr >
< ul >
< li >
< a class = padding >
< i class = "fas fa-language fa-fw" > < / i >
< div class = select-style >
2021-10-17 21:04:12 +00:00
< select id = select-language onchange = "location=baseUri+this.value" > < option id = en value = /shortcodes/mermaid/ selected > English< / option > < option id = pir value = /pir/shortcodes/mermaid/ > Arrr! Pirrrates< / option > < / select > < svg id = "Capa_1" xmlns = "http://www.w3.org/2000/svg" xmlns:xlink = "http://www.w3.org/1999/xlink" width = "255" height = "255" viewBox = "0 0 255 255" style = "enable-background:new 0 0 255 255" > < g > < g id = "arrow-drop-down" > < polygon points = "0,63.75 127.5,191.25 255,63.75" / > < / g > < / g > < / svg >
2021-10-16 23:18:04 +00:00
< / div >
< / a >
< / li >
< li > < a class = padding href = # data-clear-history-toggle > < i class = "fas fa-history fa-fw" > < / i > Clear History< / a > < / li >
< / ul >
< / div >
< div id = footer >
< a class = github-button href = https://github.com/McShelby/hugo-theme-relearn/archive/main.zip data-icon = octicon-cloud-download aria-label = "Download McShelby/hugo-theme-relearn on GitHub" > Download< / a >
< a class = github-button href = https://github.com/McShelby/hugo-theme-relearn data-icon = octicon-star data-show-count = true aria-label = "Star McShelby/hugo-theme-relearn on GitHub" > Star< / a >
< a class = github-button href = https://github.com/McShelby/hugo-theme-relearn/fork data-icon = octicon-repo-forked data-show-count = true aria-label = "Fork McShelby/hugo-theme-relearn on GitHub" > Fork< / a >
< p > Built with < a href = https://github.com/McShelby/hugo-theme-relearn > < i class = "fas fa-heart" > < / i > < / a > by < a href = https://gohugo.io/ > Hugo< / a > < / p >
< script async defer src = https://buttons.github.io/buttons.js > < / script >
< / div >
< / div >
< / nav >
< div id = body >
< div id = overlay > < / div >
< div class = "padding highlightable" >
< div id = top-bar >
< div id = top-github-link >
< a class = github-link title = "Edit this page" href = https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/shortcodes/mermaid.en.md target = blank >
< i class = "fas fa-code-branch" > < / i >
< span id = top-github-link-text > Edit this page< / span >
< / a >
< / div >
< div id = breadcrumbs >
< span id = sidebar-toggle-span >
< a href = # id = sidebar-toggle data-sidebar-toggle >
< i class = "fas fa-bars" > < / i >
< / a >
< / span >
< span id = toc-menu > < i class = "fas fa-list-alt" > < / i > < / span >
< ol class = links itemscope itemtype = http://schema.org/BreadcrumbList >
< meta itemprop = itemListOrder content = "Descending" >
2021-10-17 21:04:12 +00:00
< li itemscope itemtype = https://schema.org/ListItem itemprop = itemListElement > < meta itemprop = position content = "3" > < a itemprop = item href = ../../ > < span itemprop = name > Relearn Theme for Hugo< / span > < / a > > < / li >
< li itemscope itemtype = https://schema.org/ListItem itemprop = itemListElement > < meta itemprop = position content = "2" > < a itemprop = item href = ../../shortcodes/ > < span itemprop = name > Shortcodes< / span > < / a > > < / li >
< li itemscope itemtype = https://schema.org/ListItem itemprop = itemListElement > < meta itemprop = position content = "1" > < a itemprop = item href = ../../shortcodes/mermaid/ aria-disabled = true > < span itemprop = name > Mermaid< / span > < / a > < / li >
2021-10-16 23:18:04 +00:00
< / ol >
< / div >
< div class = progress >
< div class = wrapper >
< nav id = TableOfContents >
< ul >
< li > < a href = #usage > Usage< / a > < / li >
< li > < a href = #examples > Examples< / a >
< ul >
< li > < a href = #flowchart > Flowchart< / a > < / li >
< li > < a href = #sequence > Sequence< / a > < / li >
< li > < a href = #gantt > GANTT< / a > < / li >
< li > < a href = #class > Class< / a > < / li >
< li > < a href = #state > State< / a > < / li >
< / ul >
< / li >
< li > < a href = #configuration > Configuration< / a >
< ul >
< li > < a href = #example > Example< / a > < / li >
< / ul >
< / li >
< / ul >
< / nav >
< / div >
< / div >
< / div >
< div id = head-tags >
< / div >
< main id = body-inner >
< h1 > Mermaid< / h1 >
< p > < a href = https://mermaidjs.github.io/ > Mermaid< / a > is a library helping you to generate diagram and flowcharts from text, in a similar manner as Markdown.< / p >
< h2 id = usage > Usage< / h2 >
< p > Just insert your Mermaid code in the < code > mermaid< / code > shortcode like this:< / p >
< div class = highlight > < pre tabindex = 0 style = color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4 > < code class = language-go data-lang = go > {{< mermaid [ align=(left|right|center|justify) ] > }}
classDiagram
Person < span style = color:#ff6ac1 > *--< / span > Dog
{{< < span style = color:#ff6ac1 > /< / span > mermaid > }}
< / code > < / pre > < / div > < p > You can set an optional < code > align< / code > attribute which defaults to < code > center< / code > .< / p >
< p > If you don’ t need alignment you can use the alternative syntax using code fences if you have turned off < code > guessSyntax< / code > for the < code > markup.highlight< / code > setting (see below):< / p >
< div class = highlight > < pre tabindex = 0 style = color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4 > < code class = language-plaintext data-lang = plaintext > ```mermaid
classDiagram
Person *-- Dog
```
< / code > < / pre > < / div > < p > The generated graphs can be be panned by dragging them and zoomed by using the mousewheel. On mobile devices you can use finger gestures.< / p >
< h2 id = examples > Examples< / h2 >
< h3 id = flowchart > Flowchart< / h3 >
< div class = mermaid align = left >
graph LR;
A[Hard edge] -->|Link text| B(Round edge)
B --> C{< strong > Decision< / strong > }
C -->|One| D[Result one]
C -->|Two| E[Result two]
< / div >
< div class = "expand expand-expanded" >
< a class = expand-label onclick = "$t=$(this),$t.parent('.expand-expanded.expand-marked').length?$t.next().css('display','none'):$t.parent('.expand-marked').length?$t.next().css('display','block'):$t.next('.expand-content').slideToggle(100),$t.parent().toggleClass('expand-expanded')" >
< i class = "fas fa-chevron-down" > < / i >
< i class = "fas fa-chevron-right" > < / i >
Show markup
< / a >
< div class = expand-content style = display:block >
< div class = highlight > < pre tabindex = 0 style = color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4 > < code class = language-go data-lang = go > {{< mermaid align=< span style = color:#5af78e > " left" < / span > > }}
graph LR;
A[Hard edge] < span style = color:#ff6ac1 > --< / span > > |Link text| < span style = color:#57c7ff > B< / span > (Round edge)
B < span style = color:#ff6ac1 > --< / span > > C{< strong> Decision< < span style = color:#ff6ac1 > /< / span > strong> }
C < span style = color:#ff6ac1 > --< / span > > |One| D[Result one]
C < span style = color:#ff6ac1 > --< / span > > |Two| E[Result two]
{{< < span style = color:#ff6ac1 > /< / span > mermaid > }}
< / code > < / pre > < / div >
< / div >
< / div >
< h3 id = sequence > Sequence< / h3 >
< div class = mermaid align = center >
sequenceDiagram
participant Alice
participant Bob
Alice->>John: Hello John, how are you?
loop Healthcheck
John->John: Fight against hypochondria
end
Note right of John: Rational thoughts < br > prevail...
John-->Alice: Great!
John->Bob: How about you?
Bob-->John: Jolly good!
< / div >
< div class = "expand expand-expanded" >
< a class = expand-label onclick = "$t=$(this),$t.parent('.expand-expanded.expand-marked').length?$t.next().css('display','none'):$t.parent('.expand-marked').length?$t.next().css('display','block'):$t.next('.expand-content').slideToggle(100),$t.parent().toggleClass('expand-expanded')" >
< i class = "fas fa-chevron-down" > < / i >
< i class = "fas fa-chevron-right" > < / i >
Show markup
< / a >
< div class = expand-content style = display:block >
< div class = highlight > < pre tabindex = 0 style = color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4 > < code class = language-go data-lang = go > {{< mermaid > }}
sequenceDiagram
participant Alice
participant Bob
Alice< span style = color:#ff6ac1 > -> > < / span > John: Hello John, how are you< span style = color:#ff5c57 > ?< / span >
loop Healthcheck
John< span style = color:#ff6ac1 > -< / span > > John: Fight against hypochondria
end
Note right of John: Rational thoughts < br< span style = color:#ff6ac1 > /< / span > > prevail< span style = color:#ff6ac1 > ...< / span >
John< span style = color:#ff6ac1 > --< / span > > Alice: Great!
John< span style = color:#ff6ac1 > -< / span > > Bob: How about you< span style = color:#ff5c57 > ?< / span >
Bob< span style = color:#ff6ac1 > --< / span > > John: Jolly good!
{{< < span style = color:#ff6ac1 > /< / span > mermaid > }}
< / code > < / pre > < / div >
< / div >
< / div >
< h3 id = gantt > GANTT< / h3 >
< div class = mermaid align = center >
gantt
dateFormat YYYY-MM-DD
title Adding GANTT diagram functionality to Mermaid
section A section
Completed task :done, des1, 2014-01-06,2014-01-08
Active task :active, des2, 2014-01-09, 3d
Future task : des3, after des2, 5d
Future task2 : des4, after des3, 5d
section Critical tasks
Completed task in the critical line :crit, done, 2014-01-06,24h
Implement parser and jison :crit, done, after des1, 2d
Create tests for parser :crit, active, 3d
Future task in critical line :crit, 5d
Create tests for renderer :2d
Add to Mermaid :1d
< / div >
< div class = "expand expand-expanded" >
< a class = expand-label onclick = "$t=$(this),$t.parent('.expand-expanded.expand-marked').length?$t.next().css('display','none'):$t.parent('.expand-marked').length?$t.next().css('display','block'):$t.next('.expand-content').slideToggle(100),$t.parent().toggleClass('expand-expanded')" >
< i class = "fas fa-chevron-down" > < / i >
< i class = "fas fa-chevron-right" > < / i >
Show markup
< / a >
< div class = expand-content style = display:block >
< div class = highlight > < pre tabindex = 0 style = color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4 > < code class = language-go data-lang = go > {{< mermaid > }}
gantt
dateFormat YYYY< span style = color:#ff6ac1 > -< / span > MM< span style = color:#ff6ac1 > -< / span > DD
title Adding GANTT diagram functionality to Mermaid
section A section
Completed task :done, des1, < span style = color:#ff9f43 > 2014< / span > < span style = color:#ff6ac1 > -< / span > < span style = color:#ff9f43 > 01< / span > < span style = color:#ff6ac1 > -< / span > < span style = color:#ff9f43 > 06< / span > ,< span style = color:#ff9f43 > 2014< / span > < span style = color:#ff6ac1 > -< / span > < span style = color:#ff9f43 > 01< / span > < span style = color:#ff6ac1 > -< / span > < span style = color:#ff9f43 > 08< / span >
Active task :active, des2, < span style = color:#ff9f43 > 2014< / span > < span style = color:#ff6ac1 > -< / span > < span style = color:#ff9f43 > 01< / span > < span style = color:#ff6ac1 > -< / span > < span style = color:#ff9f43 > 09< / span > , < span style = color:#ff9f43 > 3< / span > d
Future task : des3, after des2, < span style = color:#ff9f43 > 5< / span > d
Future task2 : des4, after des3, < span style = color:#ff9f43 > 5< / span > d
section Critical tasks
Completed task in the critical line :crit, done, < span style = color:#ff9f43 > 2014< / span > < span style = color:#ff6ac1 > -< / span > < span style = color:#ff9f43 > 01< / span > < span style = color:#ff6ac1 > -< / span > < span style = color:#ff9f43 > 06< / span > ,< span style = color:#ff9f43 > 24< / span > h
Implement parser and jison :crit, done, after des1, < span style = color:#ff9f43 > 2< / span > d
Create tests < span style = color:#ff6ac1 > for< / span > parser :crit, active, < span style = color:#ff9f43 > 3< / span > d
Future task in critical line :crit, < span style = color:#ff9f43 > 5< / span > d
Create tests < span style = color:#ff6ac1 > for< / span > renderer :< span style = color:#ff9f43 > 2< / span > d
Add to Mermaid :< span style = color:#ff9f43 > 1< / span > d
{{< < span style = color:#ff6ac1 > /< / span > mermaid > }}
< / code > < / pre > < / div >
< / div >
< / div >
< h3 id = class > Class< / h3 >
< div class = mermaid align = center >
classDiagram
Class01 < |-- AveryLongClass : Cool
Class03 *-- Class04
Class05 o-- Class06
Class07 .. Class08
Class09 --> C2 : Where am i?
Class09 --* C3
Class09 --|> Class07
Class07 : equals()
Class07 : Object[] elementData
Class01 : size()
Class01 : int chimp
Class01 : int gorilla
Class08 < -- > C2: Cool label
< / div >
< div class = "expand expand-expanded" >
< a class = expand-label onclick = "$t=$(this),$t.parent('.expand-expanded.expand-marked').length?$t.next().css('display','none'):$t.parent('.expand-marked').length?$t.next().css('display','block'):$t.next('.expand-content').slideToggle(100),$t.parent().toggleClass('expand-expanded')" >
< i class = "fas fa-chevron-down" > < / i >
< i class = "fas fa-chevron-right" > < / i >
Show markup
< / a >
< div class = expand-content style = display:block >
< div class = highlight > < pre tabindex = 0 style = color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4 > < code class = language-go data-lang = go > {{< mermaid > }}
classDiagram
Class01 < |< span style = color:#ff6ac1 > --< / span > AveryLongClass : Cool
Class03 < span style = color:#ff6ac1 > *--< / span > Class04
Class05 o< span style = color:#ff6ac1 > --< / span > Class06
Class07 .. Class08
Class09 < span style = color:#ff6ac1 > --< / span > > C2 : Where am i< span style = color:#ff5c57 > ?< / span >
Class09 < span style = color:#ff6ac1 > --*< / span > C3
Class09 < span style = color:#ff6ac1 > --< / span > |> Class07
Class07 : < span style = color:#57c7ff > equals< / span > ()
Class07 : Object[] elementData
Class01 : < span style = color:#57c7ff > size< / span > ()
Class01 : < span style = color:#9aedfe > int< / span > chimp
Class01 : < span style = color:#9aedfe > int< / span > gorilla
Class08 < span style = color:#ff6ac1 > < --< / span > > C2: Cool label
{{< < span style = color:#ff6ac1 > /< / span > mermaid > }}
< / code > < / pre > < / div >
< / div >
< / div >
< h3 id = state > State< / h3 >
< pre tabindex = 0 > < code class = language-mermaid data-lang = mermaid > stateDiagram-v2
open: Open Door
closed: Closed Door
locked: Locked Door
open --> closed: Close
closed --> locked: Lock
locked --> closed: Unlock
closed --> open: Open
< / code > < / pre >
< div class = "expand expand-expanded" >
< a class = expand-label onclick = "$t=$(this),$t.parent('.expand-expanded.expand-marked').length?$t.next().css('display','none'):$t.parent('.expand-marked').length?$t.next().css('display','block'):$t.next('.expand-content').slideToggle(100),$t.parent().toggleClass('expand-expanded')" >
< i class = "fas fa-chevron-down" > < / i >
< i class = "fas fa-chevron-right" > < / i >
Show markup
< / a >
< div class = expand-content style = display:block >
< div class = highlight > < pre tabindex = 0 style = color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4 > < code class = language-go data-lang = go > < span style = color:#5af78e > ```mermaid
< / span > < span style = color:#5af78e > stateDiagram-v2
< / span > < span style = color:#5af78e > open: Open Door
< / span > < span style = color:#5af78e > closed: Closed Door
< / span > < span style = color:#5af78e > locked: Locked Door
< / span > < span style = color:#5af78e > open --> closed: Close
< / span > < span style = color:#5af78e > closed --> locked: Lock
< / span > < span style = color:#5af78e > locked --> closed: Unlock
< / span > < span style = color:#5af78e > closed --> open: Open
< / span > < span style = color:#5af78e > ```< / span >
< / code > < / pre > < / div >
< / div >
< / div >
< h2 id = configuration > Configuration< / h2 >
< p > Mermaid is configured with default settings. You can customize Mermaid’ s default settings for all of your files thru a JSON object in your < code > config.toml< / code > or override these settings sidewise thru your pages frontmatter.< / p >
< p > This JSON object is forwarded into Mermaid’ s < code > mermaid.initialize()< / code > function.< / p >
< p > See < a href = http://mermaid-js.github.io/mermaid/getting-started/Setup.html#mermaidapi-configuration-defaults > Mermaid documentation< / a > for all allowed settings.< / p >
< p > Also, if you want to use mermaid codefences, you have to turn off < code > guessSyntax< / code > for the < code > markup.highlight< / code > setting.< / p >
< h3 id = example > Example< / h3 >
< div class = highlight > < pre tabindex = 0 style = color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4 > < code class = language-toml data-lang = toml > [params]
mermaidInitialize = < span style = color:#5af78e > " { \" theme\" : \" dark\" }" < / span >
[markup]
[markup.highlight]
guessSyntax = < span style = color:#ff6ac1 > false< / span > < span style = color:#78787e > # if set to true, avoid unstyled code if no language was given but mermaid code fences will not work anymore< / span >
< / code > < / pre > < / div > < p > or pages frontmatter< / p >
< div class = highlight > < pre tabindex = 0 style = color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4 > < code class = language-toml data-lang = toml > < span style = color:#ff5c57 > +++< / span >
mermaidInitialize = < span style = color:#5af78e > " { \" theme\" : \" dark\" }" < / span >
< span style = color:#ff5c57 > +++< / span >
< / code > < / pre > < / div >
< footer class = footline >
< / footer >
< / main >
< / div >
< div id = navigation >
2021-10-17 21:04:12 +00:00
< a class = "nav nav-prev" href = ../../shortcodes/include/ title = Include > < i class = "fa fa-chevron-left" > < / i > < / a >
< a class = "nav nav-next" href = ../../shortcodes/notice/ title = Notice > < i class = "fa fa-chevron-right" > < / i > < / a >
2021-10-16 23:18:04 +00:00
< / div >
< / div >
< div style = left:-1000px;overflow:scroll;position:absolute;top:-1000px;border:none;box-sizing:content-box;height:200px;margin:0;padding:0;width:200px >
< div style = border:none;box-sizing:content-box;height:200px;margin:0;padding:0;width:200px > < / div >
< / div >
2021-10-19 15:26:14 +00:00
< script src = ../../js/clipboard.min.js?1634657171 > < / script >
< script src = ../../js/perfect-scrollbar.min.js?1634657171 > < / script >
< script src = ../../js/perfect-scrollbar.jquery.min.js?1634657171 > < / script >
< script src = ../../js/jquery.svg.pan.zoom.js?1634657171 > < / script >
< script src = ../../js/featherlight.min.js?1634657171 > < / script >
< script src = ../../js/modernizr.custom-3.6.0.js?1634657171 > < / script >
< script src = ../../js/mermaid.min.js?1634657171 > < / script >
2021-10-16 23:18:04 +00:00
< script > typeof mermaid != 'undefined' && mermaid . mermaidAPI . initialize ( Object . assign ( { securityLevel : "antiscript" } , JSON . parse ( '{ "startOnLoad": true }' ) , { startOnLoad : ! 1 } ) ) < / script >
2021-10-19 15:26:14 +00:00
< script src = ../../js/relearn.js?1634657171 > < / script >
2021-10-16 23:18:04 +00:00
< / body >
< / html >
