mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-11-27 09:43:06 +00:00
1331 lines
118 KiB
HTML
1331 lines
118 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en" dir="ltr" itemscope itemtype="http://schema.org/Article">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0">
|
|
<meta name="generator" content="Hugo 0.136.4">
|
|
<meta name="generator" content="Relearn 7.0.1+0938e8bd2e8bce8d47586b5c26e306892fcb70a9">
|
|
<meta name="description" content="Generate diagrams and flowcharts from text">
|
|
<meta name="author" content="Sören Weber">
|
|
<meta name="twitter:card" content="summary_large_image">
|
|
<meta name="twitter:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
|
|
<meta name="twitter:title" content="Mermaid :: Hugo Relearn Theme">
|
|
<meta name="twitter:description" content="Generate diagrams and flowcharts from text">
|
|
<meta property="og:url" content="https://mcshelby.github.io/hugo-theme-relearn/shortcodes/mermaid/index.html">
|
|
<meta property="og:site_name" content="Hugo Relearn Theme">
|
|
<meta property="og:title" content="Mermaid :: Hugo Relearn Theme">
|
|
<meta property="og:description" content="Generate diagrams and flowcharts from text">
|
|
<meta property="og:locale" content="en">
|
|
<meta property="og:type" content="article">
|
|
<meta property="article:section" content="Shortcodes">
|
|
<meta property="og:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
|
|
<meta itemprop="name" content="Mermaid :: Hugo Relearn Theme">
|
|
<meta itemprop="description" content="Generate diagrams and flowcharts from text">
|
|
<meta itemprop="wordCount" content="2296">
|
|
<meta itemprop="image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
|
|
<meta itemprop="keywords" content="Howto,Reference,CustomMermaidURL,Mermaid.force,MermaidInitialize,MermaidZoom,CustomMermaidURL,Mermaid.force,MermaidInitialize,MermaidZoom">
|
|
<title>Mermaid :: Hugo Relearn Theme</title>
|
|
<link href="https://mcshelby.github.io/hugo-theme-relearn/shortcodes/mermaid/index.html" rel="alternate" hreflang="x-default">
|
|
<link href="https://mcshelby.github.io/hugo-theme-relearn/shortcodes/mermaid/index.html" rel="alternate" hreflang="en">
|
|
<link href="https://mcshelby.github.io/hugo-theme-relearn/pir/shortcodes/mermaid/index.html" rel="alternate" hreflang="art-x-pir">
|
|
<link href="/hugo-theme-relearn/shortcodes/mermaid/index.xml" rel="alternate" type="application/rss+xml" title="Mermaid :: Hugo Relearn Theme">
|
|
<link href="/hugo-theme-relearn/shortcodes/mermaid/index.print.html" rel="alternate" type="text/html" title="Mermaid :: Hugo Relearn Theme">
|
|
<link href="/hugo-theme-relearn/images/logo.svg?1729784203" rel="icon" type="image/svg+xml">
|
|
<link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1729784203" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1729784203" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/nucleus.css?1729784203" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/auto-complete.css?1729784203" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/auto-complete.css?1729784203" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/perfect-scrollbar.min.css?1729784203" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/fonts.css?1729784203" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fonts.css?1729784203" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/theme.css?1729784203" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/theme-relearn-auto.css?1729784203" rel="stylesheet" id="R-variant-style">
|
|
<link href="/hugo-theme-relearn/css/chroma-relearn-auto.css?1729784203" rel="stylesheet" id="R-variant-chroma-style">
|
|
<link href="/hugo-theme-relearn/css/print.css?1729784203" rel="stylesheet" media="print">
|
|
<script src="/hugo-theme-relearn/js/variant.js?1729784203"></script>
|
|
<script>
|
|
window.relearn = window.relearn || {};
|
|
window.relearn.relBasePath='..\/..';
|
|
window.relearn.relBaseUri='..\/..\/..';
|
|
window.relearn.absBaseUri='https:\/\/mcshelby.github.io\/hugo-theme-relearn';
|
|
window.relearn.disableAnchorCopy=false;
|
|
window.relearn.disableAnchorScrolling=false;
|
|
// variant stuff
|
|
window.variants && variants.init( [ 'relearn-auto', 'relearn-light', 'relearn-dark', 'relearn-bright', 'zen-auto', 'zen-light', 'zen-dark', 'retro-auto', 'neon', 'learn', 'blue', 'green', 'red' ] );
|
|
// translations
|
|
window.T_Copy_to_clipboard = `Copy to clipboard`;
|
|
window.T_Copied_to_clipboard = `Copied to clipboard!`;
|
|
window.T_Copy_link_to_clipboard = `Copy link to clipboard`;
|
|
window.T_Link_copied_to_clipboard = `Copied link to clipboard!`;
|
|
window.T_Reset_view = `Reset view`;
|
|
window.T_View_reset = `View reset!`;
|
|
window.T_No_results_found = `No results found for "{0}"`;
|
|
window.T_N_results_found = `{1} results found for "{0}"`;
|
|
</script>
|
|
<style>
|
|
#R-body img.bg-white {
|
|
background-color: white;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body class="mobile-support html disableInlineCopyToClipboard" data-url="/hugo-theme-relearn/shortcodes/mermaid/index.html">
|
|
<div id="R-body" class="default-animation">
|
|
<div id="R-body-overlay"></div>
|
|
<nav id="R-topbar">
|
|
<div class="topbar-wrapper">
|
|
<div class="topbar-sidebar-divider"></div>
|
|
<div class="topbar-area topbar-area-start" data-area="start">
|
|
<div class="topbar-button topbar-button-sidebar" data-content-empty="disable" data-width-s="show" data-width-m="hide" data-width-l="hide"><button class="topbar-control" onclick="toggleNav()" type="button" title="Menu (CTRL+ALT+n)"><i class="fa-fw fas fa-bars"></i></button>
|
|
</div>
|
|
<div class="topbar-button topbar-button-toc" data-content-empty="hide" data-width-s="show" data-width-m="show" data-width-l="show"><button class="topbar-control" onclick="toggleTopbarFlyout(this)" type="button" title="Table of Contents (CTRL+ALT+t)"><i class="fa-fw fas fa-list-alt"></i></button>
|
|
<div class="topbar-content">
|
|
<div class="topbar-content-wrapper">
|
|
<nav class="TableOfContents">
|
|
<ul>
|
|
<li><a href="#usage">Usage</a>
|
|
<ul>
|
|
<li><a href="#parameter">Parameter</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#settings">Settings</a>
|
|
<ul>
|
|
<li><a href="#configuring-pan-and-zoom">Configuring Pan and Zoom</a></li>
|
|
<li><a href="#providing-initialization-options-for-the-mermaid-library">Providing Initialization Options for the Mermaid Library</a></li>
|
|
<li><a href="#loading-an-external-version-of-the-mermaid-library">Loading an External Version of the Mermaid Library</a></li>
|
|
<li><a href="#force-loading-of-the-mermaid-library">Force Loading of the Mermaid Library</a></li>
|
|
<li><a href="#setting-a-specific-mermaid-theme">Setting a Specific Mermaid Theme</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="#examples">Examples</a>
|
|
<ul>
|
|
<li><a href="#flowchart-with-yaml-title">Flowchart with YAML-Title</a></li>
|
|
<li><a href="#sequence-diagram-with-configuration-directive">Sequence Diagram with Configuration Directive</a></li>
|
|
<li><a href="#class-diagram">Class Diagram</a></li>
|
|
<li><a href="#state-diagram-aligned-to-the-right-using-shortcode-syntax">State Diagram Aligned to the Right Using Shortcode Syntax</a></li>
|
|
<li><a href="#entity-relationship-model-with-non-default-mermaid-theme">Entity Relationship Model with Non-Default Mermaid Theme</a></li>
|
|
<li><a href="#user-journey">User Journey</a></li>
|
|
<li><a href="#gantt-chart">GANTT Chart</a></li>
|
|
<li><a href="#pie-chart-without-zoom">Pie Chart without Zoom</a></li>
|
|
<li><a href="#quadrant-chart">Quadrant Chart</a></li>
|
|
<li><a href="#requirement-diagram">Requirement Diagram</a></li>
|
|
<li><a href="#git-graph">Git Graph</a></li>
|
|
<li><a href="#c4-diagrams">C4 Diagrams</a></li>
|
|
<li><a href="#mindmaps">Mindmaps</a></li>
|
|
<li><a href="#timeline">Timeline</a></li>
|
|
<li><a href="#sankey">Sankey</a></li>
|
|
<li><a href="#xychart">XYChart</a></li>
|
|
<li><a href="#block-diagram">Block Diagram</a></li>
|
|
<li><a href="#packet">Packet</a></li>
|
|
<li><a href="#architecture">Architecture</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<ol class="topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype="http://schema.org/BreadcrumbList"><li
|
|
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="/hugo-theme-relearn/shortcodes/index.html"><span itemprop="name">Shortcodes</span></a><meta itemprop="position" content="1"> > </li><li
|
|
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Mermaid</span><meta itemprop="position" content="2"></li>
|
|
</ol>
|
|
<div class="topbar-area topbar-area-end" data-area="end">
|
|
<div class="topbar-button topbar-button-edit" data-content-empty="disable" data-width-s="area-more" data-width-m="show" data-width-l="show"><a class="topbar-control" href="https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/shortcodes/mermaid.en.md" target="_self" title="Edit (CTRL+ALT+w)"><i class="fa-fw fas fa-pen"></i></a>
|
|
</div>
|
|
<div class="topbar-button topbar-button-print" data-content-empty="disable" data-width-s="area-more" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/shortcodes/mermaid/index.print.html" title="Print whole chapter (CTRL+ALT+p)"><i class="fa-fw fas fa-print"></i></a>
|
|
</div>
|
|
<div class="topbar-button topbar-button-prev" data-content-empty="disable" data-width-s="show" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/shortcodes/math/index.html" title="Math (🡐)"><i class="fa-fw fas fa-chevron-left"></i></a>
|
|
</div>
|
|
<div class="topbar-button topbar-button-next" data-content-empty="disable" data-width-s="show" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/shortcodes/notice/index.html" title="Notice (🡒)"><i class="fa-fw fas fa-chevron-right"></i></a>
|
|
</div>
|
|
<div class="topbar-button topbar-button-more" data-content-empty="hide" data-width-s="show" data-width-m="show" data-width-l="show"><button class="topbar-control" onclick="toggleTopbarFlyout(this)" type="button" title="More"><i class="fa-fw fas fa-ellipsis-v"></i></button>
|
|
<div class="topbar-content">
|
|
<div class="topbar-content-wrapper">
|
|
<div class="topbar-area topbar-area-more" data-area="more">
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
<div id="R-main-overlay"></div>
|
|
<main id="R-body-inner" class="highlightable shortcodes" tabindex="-1">
|
|
<div class="flex-block-wrapper">
|
|
<article class="default">
|
|
<header class="headline">
|
|
</header>
|
|
|
|
<h1 id="mermaid">Mermaid</h1>
|
|
|
|
<p>The <code>mermaid</code> shortcode generates diagrams and flowcharts from text in a similar manner as Markdown using the <a href="https://mermaidjs.github.io/" rel="external" target="_self">Mermaid</a> library.</p>
|
|
<pre class="mermaid align-center zoomable">graph LR;
|
|
If --> Then
|
|
Then --> Else</pre>
|
|
<h2 id="usage">Usage</h2>
|
|
<div class="tab-panel" data-tab-group="shortcode-parameter">
|
|
<div class="tab-nav">
|
|
<div class="tab-nav-title">​</div>
|
|
<button
|
|
data-tab-item="codefence"
|
|
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
|
onclick="switchTab('shortcode-parameter','codefence')"
|
|
>
|
|
<span class="tab-nav-text">codefence</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="shortcode"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('shortcode-parameter','shortcode')"
|
|
>
|
|
<span class="tab-nav-text">shortcode</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="partial"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('shortcode-parameter','partial')"
|
|
>
|
|
<span class="tab-nav-text">partial</span>
|
|
</button>
|
|
</div>
|
|
<div class="tab-content-container">
|
|
<div
|
|
data-tab-item="codefence"
|
|
class="tab-content tab-panel-style cstyle initial active">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">```mermaid {align="center" zoom="true"}
|
|
</span></span><span class="line"><span class="cl">graph LR;
|
|
</span></span><span class="line"><span class="cl"> If --> Then
|
|
</span></span><span class="line"><span class="cl"> Then --> Else
|
|
</span></span><span class="line"><span class="cl">```</span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="shortcode"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">mermaid</span> <span class="nx">align</span><span class="p">=</span><span class="s">"center"</span> <span class="nx">zoom</span><span class="p">=</span><span class="s">"true"</span> <span class="p">>}}</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">graph</span> <span class="nx">LR</span><span class="p">;</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">If</span> <span class="o">--</span><span class="p">></span> <span class="nx">Then</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">Then</span> <span class="o">--</span><span class="p">></span> <span class="nx">Else</span>
|
|
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">>}}</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="partial"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{</span> <span class="nx">partial</span> <span class="s">"shortcodes/mermaid.html"</span> <span class="p">(</span><span class="nx">dict</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="s">"page"</span> <span class="p">.</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="s">"content"</span> <span class="s">"graph LR;\n If --> Then\n Then --> Else"</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="s">"align"</span> <span class="s">"center"</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="s">"zoom"</span> <span class="s">"true"</span>
|
|
</span></span><span class="line"><span class="cl"><span class="p">)}}</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<p>Codefence syntax is widely available in other Markdown parsers like GitHub and therefore is the recommend syntax for generating portable Markdown.</p>
|
|
<h3 id="parameter">Parameter</h3>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Default</th>
|
|
<th>Notes</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><strong>align</strong></td>
|
|
<td><code>center</code></td>
|
|
<td>The vertical alignment.<br><br>Allowed values are <code>left</code>, <code>center</code> or <code>right</code>.</td>
|
|
</tr>
|
|
<tr>
|
|
<td><strong>zoom</strong></td>
|
|
<td>see notes</td>
|
|
<td>Whether the graph is pan- and zoomable.<br><br>If not set the value is determined by the <a href="/hugo-theme-relearn/shortcodes/mermaid/index.html#configuring-pan-and-zoom"><code>mermaidZoom</code> setting</a> of your configurations options or the pages front matter or <code>false</code> if not set at all.<br><br>- <code>false</code>: no pan or zoom<br>- <code>true</code>: pan and zoom active</td>
|
|
</tr>
|
|
<tr>
|
|
<td><em><strong><content></strong></em></td>
|
|
<td><em><empty></em></td>
|
|
<td>Your Mermaid graph.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="settings">Settings</h2>
|
|
<h3 id="configuring-pan-and-zoom">Configuring Pan and Zoom</h3>
|
|
<p><span class="badge cstyle cyan badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-gears"></i></span><span class="badge-content">Option</span></span> <span class="badge cstyle green badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-markdown"></i></span><span class="badge-content">Front Matter</span></span> The generated graphs can be panned by dragging them and zoomed by using the mousewheel. On mobile devices you can use finger gestures.</p>
|
|
<p>By default this is disabled. Set <code>mermaidZoom=true</code> to enable it.</p>
|
|
<p>Individual settings of a graphs <a href="/hugo-theme-relearn/shortcodes/mermaid/index.html#parameter"><code>zoom</code> parameter</a> have precedence over the page’s front matter and configuration options in that order.</p>
|
|
<div class="tab-panel" data-tab-group="config-code">
|
|
<div class="tab-nav">
|
|
<div class="tab-nav-title">​</div>
|
|
<button
|
|
data-tab-item="toml"
|
|
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
|
onclick="switchTab('config-code','toml')"
|
|
>
|
|
<span class="tab-nav-text">toml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="yaml"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','yaml')"
|
|
>
|
|
<span class="tab-nav-text">yaml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="json"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','json')"
|
|
>
|
|
<span class="tab-nav-text">json</span>
|
|
</button>
|
|
</div>
|
|
<div class="tab-content-container">
|
|
<div
|
|
data-tab-item="toml"
|
|
class="tab-content tab-panel-style cstyle initial active">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="nx">mermaidZoom</span> <span class="p">=</span> <span class="kc">true</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="yaml"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="nt">mermaidZoom</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="json"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"mermaidZoom"</span><span class="p">:</span> <span class="kc">true</span>
|
|
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h3 id="providing-initialization-options-for-the-mermaid-library">Providing Initialization Options for the Mermaid Library</h3>
|
|
<p><span class="badge cstyle cyan badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-gears"></i></span><span class="badge-content">Option</span></span> <span class="badge cstyle green badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-markdown"></i></span><span class="badge-content">Front Matter</span></span> The Mermaid library is configured with default settings for initialization.</p>
|
|
<p>You can overwrite the settings by providing a JSON object in <code>mermaidInitialize</code>. See <a href="https://mermaid-js.github.io/mermaid/#/Setup?id=mermaidapi-configuration-defaults" rel="external" target="_self">Mermaid’s documentation</a> for all allowed settings.</p>
|
|
<p>Keep in mind that initialization settings of your pages front matter overwrite all settings of your configuration options.</p>
|
|
<p>In addition, you can merge settings for each individual graph through <a href="https://mermaid-js.github.io/mermaid/#/directives?id=directives" rel="external" target="_self">diagram directives</a> on top of the settings of your page’s front matter or configuration options.</p>
|
|
<div class="tab-panel" data-tab-group="config-code">
|
|
<div class="tab-nav">
|
|
<div class="tab-nav-title">​</div>
|
|
<button
|
|
data-tab-item="toml"
|
|
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
|
onclick="switchTab('config-code','toml')"
|
|
>
|
|
<span class="tab-nav-text">toml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="yaml"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','yaml')"
|
|
>
|
|
<span class="tab-nav-text">yaml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="json"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','json')"
|
|
>
|
|
<span class="tab-nav-text">json</span>
|
|
</button>
|
|
</div>
|
|
<div class="tab-content-container">
|
|
<div
|
|
data-tab-item="toml"
|
|
class="tab-content tab-panel-style cstyle initial active">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="nx">mermaidInitialize</span> <span class="p">=</span> <span class="s1">'{ "securityLevel": "loose" }'</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="yaml"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="nt">mermaidInitialize</span><span class="p">:</span><span class="w"> </span><span class="s1">'{ "securityLevel": "loose" }'</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="json"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"mermaidInitialize"</span><span class="p">:</span> <span class="s2">"{ \"securityLevel\": \"loose\" }"</span>
|
|
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h3 id="loading-an-external-version-of-the-mermaid-library">Loading an External Version of the Mermaid Library</h3>
|
|
<p><span class="badge cstyle cyan badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-gears"></i></span><span class="badge-content">Option</span></span> <span class="badge cstyle green badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-markdown"></i></span><span class="badge-content">Front Matter</span></span> The theme uses the shipped Mermaid library by default.</p>
|
|
<p>In case you want do use a different version of the Mermaid library but don’t want to override the shipped version, you can set <code>customMermaidURL</code> to the URL of the external Mermaid library.</p>
|
|
<div class="tab-panel" data-tab-group="config-code">
|
|
<div class="tab-nav">
|
|
<div class="tab-nav-title">​</div>
|
|
<button
|
|
data-tab-item="toml"
|
|
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
|
onclick="switchTab('config-code','toml')"
|
|
>
|
|
<span class="tab-nav-text">toml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="yaml"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','yaml')"
|
|
>
|
|
<span class="tab-nav-text">yaml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="json"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','json')"
|
|
>
|
|
<span class="tab-nav-text">json</span>
|
|
</button>
|
|
</div>
|
|
<div class="tab-content-container">
|
|
<div
|
|
data-tab-item="toml"
|
|
class="tab-content tab-panel-style cstyle initial active">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="nx">customMermaidURL</span> <span class="p">=</span> <span class="s1">'https://unpkg.com/mermaid/dist/mermaid.min.js'</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="yaml"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="nt">customMermaidURL</span><span class="p">:</span><span class="w"> </span><span class="l">https://unpkg.com/mermaid/dist/mermaid.min.js</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="json"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"customMermaidURL"</span><span class="p">:</span> <span class="s2">"https://unpkg.com/mermaid/dist/mermaid.min.js"</span>
|
|
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h3 id="force-loading-of-the-mermaid-library">Force Loading of the Mermaid Library</h3>
|
|
<p><span class="badge cstyle cyan badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-gears"></i></span><span class="badge-content">Option</span></span> <span class="badge cstyle green badge-with-title"><span class="badge-title"><i class="fa-fw fab fa-markdown"></i></span><span class="badge-content">Front Matter</span></span> The Mermaid library will be loaded if the page contains an <code>mermaid</code> shortcode or codefence.</p>
|
|
<p>You can force loading the Mermaid library if no shortcode or codefence was used by setting <code>mermaid.force=true</code>. If a shortcode or codefence was found, this option has no effect. This comes handy in case you are using scripting to render a graph.</p>
|
|
<div class="tab-panel" data-tab-group="config-code">
|
|
<div class="tab-nav">
|
|
<div class="tab-nav-title">​</div>
|
|
<button
|
|
data-tab-item="toml"
|
|
class="tab-nav-button tab-panel-style cstyle initial active" tabindex="-1"
|
|
onclick="switchTab('config-code','toml')"
|
|
>
|
|
<span class="tab-nav-text">toml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="yaml"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','yaml')"
|
|
>
|
|
<span class="tab-nav-text">yaml</span>
|
|
</button>
|
|
<button
|
|
data-tab-item="json"
|
|
class="tab-nav-button tab-panel-style cstyle initial"
|
|
onclick="switchTab('config-code','json')"
|
|
>
|
|
<span class="tab-nav-text">json</span>
|
|
</button>
|
|
</div>
|
|
<div class="tab-content-container">
|
|
<div
|
|
data-tab-item="toml"
|
|
class="tab-content tab-panel-style cstyle initial active">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-toml" data-lang="toml"><span class="line"><span class="cl"><span class="p">[</span><span class="nx">mermaid</span><span class="p">]</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">force</span> <span class="p">=</span> <span class="kc">true</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="yaml"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-yaml" data-lang="yaml"><span class="line"><span class="cl"><span class="nt">mermaid</span><span class="p">:</span><span class="w">
|
|
</span></span></span><span class="line"><span class="cl"><span class="w"> </span><span class="nt">force</span><span class="p">:</span><span class="w"> </span><span class="kc">true</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div
|
|
data-tab-item="json"
|
|
class="tab-content tab-panel-style cstyle initial">
|
|
<div class="tab-content-text">
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-json" data-lang="json"><span class="line"><span class="cl"><span class="p">{</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"mermaid"</span><span class="p">:</span> <span class="p">{</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nt">"force"</span><span class="p">:</span> <span class="kc">true</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="p">}</span>
|
|
</span></span><span class="line"><span class="cl"><span class="p">}</span></span></span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h3 id="setting-a-specific-mermaid-theme">Setting a Specific Mermaid Theme</h3>
|
|
<p>While you can configure the Mermaid theme to render your graph by using one of the <a href="/hugo-theme-relearn/shortcodes/mermaid/index.html#providing-initialization-options-for-the-mermaid-library">initialization options</a>, the recommended way is to set the default value using the <code>--MERMAID-theme</code> variable in your <a href="/hugo-theme-relearn/configuration/branding/generator/index.html">color variant stylesheet</a>. This allows your graphs to look pretty when the user switches the color variant.</p>
|
|
<h2 id="examples">Examples</h2>
|
|
<h3 id="flowchart-with-yaml-title">Flowchart with YAML-Title</h3>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="s">```mermaid
|
|
</span></span></span><span class="line"><span class="cl"><span class="s"></span>---
|
|
</span></span><span class="line"><span class="cl">title: Example Diagram
|
|
</span></span><span class="line"><span class="cl">---
|
|
</span></span><span class="line"><span class="cl">graph LR;
|
|
</span></span><span class="line"><span class="cl"> A[Hard edge] -->|Link text| B(Round edge)
|
|
</span></span><span class="line"><span class="cl"> B --> C{<strong>Decision</strong>}
|
|
</span></span><span class="line"><span class="cl"> C -->|One| D[Result one]
|
|
</span></span><span class="line"><span class="cl"> C -->|Two| E[Result two]
|
|
</span></span><span class="line"><span class="cl"><span class="s">```</span></span></span></code></pre></div>
|
|
<pre class="mermaid align-center zoomable">---
|
|
title: Example Diagram
|
|
---
|
|
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]</pre>
|
|
<h3 id="sequence-diagram-with-configuration-directive">Sequence Diagram with Configuration Directive</h3>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="s">```mermaid
|
|
</span></span></span><span class="line"><span class="cl"><span class="s"></span>%%{init:{"fontFamily":"monospace", "sequence":{"showSequenceNumbers":true}}}%%
|
|
</span></span><span class="line"><span class="cl">sequenceDiagram
|
|
</span></span><span class="line"><span class="cl"> Alice->>John: Hello John, how are you?
|
|
</span></span><span class="line"><span class="cl"> loop Healthcheck
|
|
</span></span><span class="line"><span class="cl"> John->>John: Fight against hypochondria
|
|
</span></span><span class="line"><span class="cl"> end
|
|
</span></span><span class="line"><span class="cl"> Note right of John: Rational thoughts!
|
|
</span></span><span class="line"><span class="cl"> John-->>Alice: Great!
|
|
</span></span><span class="line"><span class="cl"> John->>Bob: How about you?
|
|
</span></span><span class="line"><span class="cl"> Bob-->>John: Jolly good!
|
|
</span></span><span class="line"><span class="cl"><span class="s">```</span></span></span></code></pre></div>
|
|
<pre class="mermaid align-center zoomable">%%{init:{"fontFamily":"monospace", "sequence":{"showSequenceNumbers":true}}}%%
|
|
sequenceDiagram
|
|
Alice->>John: Hello John, how are you?
|
|
loop Healthcheck
|
|
John->>John: Fight against hypochondria
|
|
end
|
|
Note right of John: Rational thoughts!
|
|
John-->>Alice: Great!
|
|
John->>Bob: How about you?
|
|
Bob-->>John: Jolly good!</pre>
|
|
<h3 id="class-diagram">Class Diagram</h3>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="s">```mermaid
|
|
</span></span></span><span class="line"><span class="cl"><span class="s"></span>classDiagram
|
|
</span></span><span class="line"><span class="cl"> Animal <|-- Duck
|
|
</span></span><span class="line"><span class="cl"> Animal <|-- Fish
|
|
</span></span><span class="line"><span class="cl"> Animal <|-- Zebra
|
|
</span></span><span class="line"><span class="cl"> Animal : +int age
|
|
</span></span><span class="line"><span class="cl"> Animal : +String gender
|
|
</span></span><span class="line"><span class="cl"> Animal: +isMammal()
|
|
</span></span><span class="line"><span class="cl"> Animal: +mate()
|
|
</span></span><span class="line"><span class="cl"> class Duck{
|
|
</span></span><span class="line"><span class="cl"> +String beakColor
|
|
</span></span><span class="line"><span class="cl"> +swim()
|
|
</span></span><span class="line"><span class="cl"> +quack()
|
|
</span></span><span class="line"><span class="cl"> }
|
|
</span></span><span class="line"><span class="cl"> class Fish{
|
|
</span></span><span class="line"><span class="cl"> -int sizeInFeet
|
|
</span></span><span class="line"><span class="cl"> -canEat()
|
|
</span></span><span class="line"><span class="cl"> }
|
|
</span></span><span class="line"><span class="cl"> class Zebra{
|
|
</span></span><span class="line"><span class="cl"> +bool is_wild
|
|
</span></span><span class="line"><span class="cl"> +run()
|
|
</span></span><span class="line"><span class="cl"> }
|
|
</span></span><span class="line"><span class="cl"><span class="s">```</span></span></span></code></pre></div>
|
|
<pre class="mermaid align-center zoomable">classDiagram
|
|
Animal <|-- Duck
|
|
Animal <|-- Fish
|
|
Animal <|-- Zebra
|
|
Animal : +int age
|
|
Animal : +String gender
|
|
Animal: +isMammal()
|
|
Animal: +mate()
|
|
class Duck{
|
|
+String beakColor
|
|
+swim()
|
|
+quack()
|
|
}
|
|
class Fish{
|
|
-int sizeInFeet
|
|
-canEat()
|
|
}
|
|
class Zebra{
|
|
+bool is_wild
|
|
+run()
|
|
}</pre>
|
|
<h3 id="state-diagram-aligned-to-the-right-using-shortcode-syntax">State Diagram Aligned to the Right Using Shortcode Syntax</h3>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="line"><span class="cl"><span class="p">{{<</span> <span class="nx">mermaid</span> <span class="nx">align</span><span class="p">=</span><span class="s">"right"</span> <span class="p">>}}</span>
|
|
</span></span><span class="line"><span class="cl"><span class="nx">stateDiagram</span><span class="o">-</span><span class="nx">v2</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">open</span><span class="p">:</span> <span class="nx">Open</span> <span class="nx">Door</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">closed</span><span class="p">:</span> <span class="nx">Closed</span> <span class="nx">Door</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">locked</span><span class="p">:</span> <span class="nx">Locked</span> <span class="nx">Door</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">open</span> <span class="o">--</span><span class="p">></span> <span class="nx">closed</span><span class="p">:</span> <span class="nx">Close</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">closed</span> <span class="o">--</span><span class="p">></span> <span class="nx">locked</span><span class="p">:</span> <span class="nx">Lock</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">locked</span> <span class="o">--</span><span class="p">></span> <span class="nx">closed</span><span class="p">:</span> <span class="nx">Unlock</span>
|
|
</span></span><span class="line"><span class="cl"> <span class="nx">closed</span> <span class="o">--</span><span class="p">></span> <span class="nx">open</span><span class="p">:</span> <span class="nx">Open</span>
|
|
</span></span><span class="line"><span class="cl"><span class="p">{{<</span> <span class="o">/</span><span class="nx">mermaid</span> <span class="p">>}}</span></span></span></code></pre></div>
|
|
<pre class="mermaid align-right zoomable">
|
|
stateDiagram-v2
|
|
open: Open Door
|
|
closed: Closed Door
|
|
locked: Locked Door
|
|
open --> closed: Close
|
|
closed --> locked: Lock
|
|
locked --> closed: Unlock
|
|
closed --> open: Open
|
|
</pre>
|
|
<h3 id="entity-relationship-model-with-non-default-mermaid-theme">Entity Relationship Model with Non-Default Mermaid Theme</h3>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="s">```mermaid
|
|
</span></span></span><span class="line"><span class="cl"><span class="s"></span>%%{init:{"theme":"forest"}}%%
|
|
</span></span><span class="line"><span class="cl">erDiagram
|
|
</span></span><span class="line"><span class="cl"> CUSTOMER }|..|{ DELIVERY-ADDRESS : has
|
|
</span></span><span class="line"><span class="cl"> CUSTOMER ||--o{ ORDER : places
|
|
</span></span><span class="line"><span class="cl"> CUSTOMER ||--o{ INVOICE : "liable for"
|
|
</span></span><span class="line"><span class="cl"> DELIVERY-ADDRESS ||--o{ ORDER : receives
|
|
</span></span><span class="line"><span class="cl"> INVOICE ||--|{ ORDER : covers
|
|
</span></span><span class="line"><span class="cl"> ORDER ||--|{ ORDER-ITEM : includes
|
|
</span></span><span class="line"><span class="cl"> PRODUCT-CATEGORY ||--|{ PRODUCT : contains
|
|
</span></span><span class="line"><span class="cl"> PRODUCT ||--o{ ORDER-ITEM : "ordered in"
|
|
</span></span><span class="line"><span class="cl"><span class="s">```</span></span></span></code></pre></div>
|
|
<pre class="mermaid align-center zoomable">%%{init:{"theme":"forest"}}%%
|
|
erDiagram
|
|
CUSTOMER }|..|{ DELIVERY-ADDRESS : has
|
|
CUSTOMER ||--o{ ORDER : places
|
|
CUSTOMER ||--o{ INVOICE : "liable for"
|
|
DELIVERY-ADDRESS ||--o{ ORDER : receives
|
|
INVOICE ||--|{ ORDER : covers
|
|
ORDER ||--|{ ORDER-ITEM : includes
|
|
PRODUCT-CATEGORY ||--|{ PRODUCT : contains
|
|
PRODUCT ||--o{ ORDER-ITEM : "ordered in"</pre>
|
|
<h3 id="user-journey">User Journey</h3>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="s">```mermaid
|
|
</span></span></span><span class="line"><span class="cl"><span class="s"></span>journey
|
|
</span></span><span class="line"><span class="cl"> title My working day
|
|
</span></span><span class="line"><span class="cl"> section Go to work
|
|
</span></span><span class="line"><span class="cl"> Make tea: 5: Me
|
|
</span></span><span class="line"><span class="cl"> Go upstairs: 3: Me
|
|
</span></span><span class="line"><span class="cl"> Do work: 1: Me, Cat
|
|
</span></span><span class="line"><span class="cl"> section Go home
|
|
</span></span><span class="line"><span class="cl"> Go downstairs: 5: Me
|
|
</span></span><span class="line"><span class="cl"> Sit down: 3: Me
|
|
</span></span><span class="line"><span class="cl"><span class="s">```</span></span></span></code></pre></div>
|
|
<pre class="mermaid align-center zoomable">journey
|
|
title My working day
|
|
section Go to work
|
|
Make tea: 5: Me
|
|
Go upstairs: 3: Me
|
|
Do work: 1: Me, Cat
|
|
section Go home
|
|
Go downstairs: 5: Me
|
|
Sit down: 3: Me</pre>
|
|
<h3 id="gantt-chart">GANTT Chart</h3>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="s">```mermaid
|
|
</span></span></span><span class="line"><span class="cl"><span class="s"></span>gantt
|
|
</span></span><span class="line"><span class="cl"> dateFormat YYYY-MM-DD
|
|
</span></span><span class="line"><span class="cl"> title Adding GANTT diagram functionality to Mermaid
|
|
</span></span><span class="line"><span class="cl"> section A section
|
|
</span></span><span class="line"><span class="cl"> Completed task :done, des1, 2014-01-06,2014-01-08
|
|
</span></span><span class="line"><span class="cl"> Active task :active, des2, 2014-01-09, 3d
|
|
</span></span><span class="line"><span class="cl"> Future task : des3, after des2, 5d
|
|
</span></span><span class="line"><span class="cl"> Future task2 : des4, after des3, 5d
|
|
</span></span><span class="line"><span class="cl"> section Critical tasks
|
|
</span></span><span class="line"><span class="cl"> Completed task in the critical line :crit, done, 2014-01-06,24h
|
|
</span></span><span class="line"><span class="cl"> Implement parser and jison :crit, done, after des1, 2d
|
|
</span></span><span class="line"><span class="cl"> Create tests for parser :crit, active, 3d
|
|
</span></span><span class="line"><span class="cl"> Future task in critical line :crit, 5d
|
|
</span></span><span class="line"><span class="cl"> Create tests for renderer :2d
|
|
</span></span><span class="line"><span class="cl"> Add to Mermaid :1d
|
|
</span></span><span class="line"><span class="cl"><span class="s">```</span></span></span></code></pre></div>
|
|
<pre class="mermaid align-center zoomable">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</pre>
|
|
<h3 id="pie-chart-without-zoom">Pie Chart without Zoom</h3>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl">```mermaid {zoom="false"}
|
|
</span></span><span class="line"><span class="cl">pie title Pets adopted by volunteers
|
|
</span></span><span class="line"><span class="cl"> "Dogs" : 386
|
|
</span></span><span class="line"><span class="cl"> "Cats" : 85
|
|
</span></span><span class="line"><span class="cl"> "Rats" : 15
|
|
</span></span><span class="line"><span class="cl">```</span></span></code></pre></div>
|
|
<pre class="mermaid align-center zoomable">pie title Pets adopted by volunteers
|
|
"Dogs" : 386
|
|
"Cats" : 85
|
|
"Rats" : 15</pre>
|
|
<h3 id="quadrant-chart">Quadrant Chart</h3>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="s">```mermaid
|
|
</span></span></span><span class="line"><span class="cl"><span class="s"></span>quadrantChart
|
|
</span></span><span class="line"><span class="cl"> title Reach and engagement of campaigns
|
|
</span></span><span class="line"><span class="cl"> x-axis Low Reach --> High Reach
|
|
</span></span><span class="line"><span class="cl"> y-axis Low Engagement --> High Engagement
|
|
</span></span><span class="line"><span class="cl"> quadrant-1 We should expand
|
|
</span></span><span class="line"><span class="cl"> quadrant-2 Need to promote
|
|
</span></span><span class="line"><span class="cl"> quadrant-3 Re-evaluate
|
|
</span></span><span class="line"><span class="cl"> quadrant-4 May be improved
|
|
</span></span><span class="line"><span class="cl"> Campaign A: [0.3, 0.6]
|
|
</span></span><span class="line"><span class="cl"> Campaign B: [0.45, 0.23]
|
|
</span></span><span class="line"><span class="cl"> Campaign C: [0.57, 0.69]
|
|
</span></span><span class="line"><span class="cl"> Campaign D: [0.78, 0.34]
|
|
</span></span><span class="line"><span class="cl"> Campaign E: [0.40, 0.34]
|
|
</span></span><span class="line"><span class="cl"> Campaign F: [0.35, 0.78]
|
|
</span></span><span class="line"><span class="cl"><span class="s">```</span></span></span></code></pre></div>
|
|
<pre class="mermaid align-center zoomable">quadrantChart
|
|
title Reach and engagement of campaigns
|
|
x-axis Low Reach --> High Reach
|
|
y-axis Low Engagement --> High Engagement
|
|
quadrant-1 We should expand
|
|
quadrant-2 Need to promote
|
|
quadrant-3 Re-evaluate
|
|
quadrant-4 May be improved
|
|
Campaign A: [0.3, 0.6]
|
|
Campaign B: [0.45, 0.23]
|
|
Campaign C: [0.57, 0.69]
|
|
Campaign D: [0.78, 0.34]
|
|
Campaign E: [0.40, 0.34]
|
|
Campaign F: [0.35, 0.78]</pre>
|
|
<h3 id="requirement-diagram">Requirement Diagram</h3>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="s">```mermaid
|
|
</span></span></span><span class="line"><span class="cl"><span class="s"></span>requirementDiagram
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> requirement test_req {
|
|
</span></span><span class="line"><span class="cl"> id: 1
|
|
</span></span><span class="line"><span class="cl"> text: the test text.
|
|
</span></span><span class="line"><span class="cl"> risk: high
|
|
</span></span><span class="line"><span class="cl"> verifymethod: test
|
|
</span></span><span class="line"><span class="cl"> }
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> element test_entity {
|
|
</span></span><span class="line"><span class="cl"> type: simulation
|
|
</span></span><span class="line"><span class="cl"> }
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> test_entity - satisfies -> test_req
|
|
</span></span><span class="line"><span class="cl"><span class="s">```</span></span></span></code></pre></div>
|
|
<pre class="mermaid align-center zoomable">requirementDiagram
|
|
|
|
requirement test_req {
|
|
id: 1
|
|
text: the test text.
|
|
risk: high
|
|
verifymethod: test
|
|
}
|
|
|
|
element test_entity {
|
|
type: simulation
|
|
}
|
|
|
|
test_entity - satisfies -> test_req</pre>
|
|
<h3 id="git-graph">Git Graph</h3>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="s">```mermaid
|
|
</span></span></span><span class="line"><span class="cl"><span class="s"></span>gitGraph
|
|
</span></span><span class="line"><span class="cl"> commit
|
|
</span></span><span class="line"><span class="cl"> commit
|
|
</span></span><span class="line"><span class="cl"> branch develop
|
|
</span></span><span class="line"><span class="cl"> checkout develop
|
|
</span></span><span class="line"><span class="cl"> commit
|
|
</span></span><span class="line"><span class="cl"> commit
|
|
</span></span><span class="line"><span class="cl"> checkout main
|
|
</span></span><span class="line"><span class="cl"> merge develop
|
|
</span></span><span class="line"><span class="cl"> commit
|
|
</span></span><span class="line"><span class="cl"> commit
|
|
</span></span><span class="line"><span class="cl"><span class="s">```</span></span></span></code></pre></div>
|
|
<pre class="mermaid align-center zoomable">gitGraph
|
|
commit
|
|
commit
|
|
branch develop
|
|
checkout develop
|
|
commit
|
|
commit
|
|
checkout main
|
|
merge develop
|
|
commit
|
|
commit</pre>
|
|
<h3 id="c4-diagrams">C4 Diagrams</h3>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="s">```mermaid
|
|
</span></span></span><span class="line"><span class="cl"><span class="s"></span>C4Context
|
|
</span></span><span class="line"><span class="cl"> title System Context diagram for Internet Banking System
|
|
</span></span><span class="line"><span class="cl"> Enterprise_Boundary(b0, "BankBoundary0") {
|
|
</span></span><span class="line"><span class="cl"> Person(customerA, "Banking Customer A", "A customer of the bank, with personal bank accounts.")
|
|
</span></span><span class="line"><span class="cl"> Person(customerB, "Banking Customer B")
|
|
</span></span><span class="line"><span class="cl"> Person_Ext(customerC, "Banking Customer C", "desc")
|
|
</span></span><span class="line"><span class="cl"> Person(customerD, "Banking Customer D", "A customer of the bank, <br/> with personal bank accounts.")
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> System(SystemAA, "Internet Banking System", "Allows customers to view information about their bank accounts, and make payments.")
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> Enterprise_Boundary(b1, "BankBoundary") {
|
|
</span></span><span class="line"><span class="cl"> SystemDb_Ext(SystemE, "Mainframe Banking System", "Stores all of the core banking information about customers, accounts, transactions, etc.")
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> System_Boundary(b2, "BankBoundary2") {
|
|
</span></span><span class="line"><span class="cl"> System(SystemA, "Banking System A")
|
|
</span></span><span class="line"><span class="cl"> System(SystemB, "Banking System B", "A system of the bank, with personal bank accounts. next line.")
|
|
</span></span><span class="line"><span class="cl"> }
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> System_Ext(SystemC, "E-mail system", "The internal Microsoft Exchange e-mail system.")
|
|
</span></span><span class="line"><span class="cl"> SystemDb(SystemD, "Banking System D Database", "A system of the bank, with personal bank accounts.")
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> Boundary(b3, "BankBoundary3", "boundary") {
|
|
</span></span><span class="line"><span class="cl"> SystemQueue(SystemF, "Banking System F Queue", "A system of the bank.")
|
|
</span></span><span class="line"><span class="cl"> SystemQueue_Ext(SystemG, "Banking System G Queue", "A system of the bank, with personal bank accounts.")
|
|
</span></span><span class="line"><span class="cl"> }
|
|
</span></span><span class="line"><span class="cl"> }
|
|
</span></span><span class="line"><span class="cl"> }
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> BiRel(customerA, SystemAA, "Uses")
|
|
</span></span><span class="line"><span class="cl"> BiRel(SystemAA, SystemE, "Uses")
|
|
</span></span><span class="line"><span class="cl"> Rel(SystemAA, SystemC, "Sends e-mails", "SMTP")
|
|
</span></span><span class="line"><span class="cl"> Rel(SystemC, customerA, "Sends e-mails to")
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> UpdateElementStyle(customerA, $fontColor="red", $bgColor="grey", $borderColor="red")
|
|
</span></span><span class="line"><span class="cl"> UpdateRelStyle(customerA, SystemAA, $textColor="blue", $lineColor="blue", $offsetX="5")
|
|
</span></span><span class="line"><span class="cl"> UpdateRelStyle(SystemAA, SystemE, $textColor="blue", $lineColor="blue", $offsetY="-10")
|
|
</span></span><span class="line"><span class="cl"> UpdateRelStyle(SystemAA, SystemC, $textColor="blue", $lineColor="blue", $offsetY="-40", $offsetX="-50")
|
|
</span></span><span class="line"><span class="cl"> UpdateRelStyle(SystemC, customerA, $textColor="red", $lineColor="red", $offsetX="-50", $offsetY="20")
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> UpdateLayoutConfig($c4ShapeInRow="3", $c4BoundaryInRow="1")
|
|
</span></span><span class="line"><span class="cl"><span class="s">```</span></span></span></code></pre></div>
|
|
<pre class="mermaid align-center zoomable">C4Context
|
|
title System Context diagram for Internet Banking System
|
|
Enterprise_Boundary(b0, "BankBoundary0") {
|
|
Person(customerA, "Banking Customer A", "A customer of the bank, with personal bank accounts.")
|
|
Person(customerB, "Banking Customer B")
|
|
Person_Ext(customerC, "Banking Customer C", "desc")
|
|
Person(customerD, "Banking Customer D", "A customer of the bank, <br/> with personal bank accounts.")
|
|
|
|
System(SystemAA, "Internet Banking System", "Allows customers to view information about their bank accounts, and make payments.")
|
|
|
|
Enterprise_Boundary(b1, "BankBoundary") {
|
|
SystemDb_Ext(SystemE, "Mainframe Banking System", "Stores all of the core banking information about customers, accounts, transactions, etc.")
|
|
|
|
System_Boundary(b2, "BankBoundary2") {
|
|
System(SystemA, "Banking System A")
|
|
System(SystemB, "Banking System B", "A system of the bank, with personal bank accounts. next line.")
|
|
}
|
|
|
|
System_Ext(SystemC, "E-mail system", "The internal Microsoft Exchange e-mail system.")
|
|
SystemDb(SystemD, "Banking System D Database", "A system of the bank, with personal bank accounts.")
|
|
|
|
Boundary(b3, "BankBoundary3", "boundary") {
|
|
SystemQueue(SystemF, "Banking System F Queue", "A system of the bank.")
|
|
SystemQueue_Ext(SystemG, "Banking System G Queue", "A system of the bank, with personal bank accounts.")
|
|
}
|
|
}
|
|
}
|
|
|
|
BiRel(customerA, SystemAA, "Uses")
|
|
BiRel(SystemAA, SystemE, "Uses")
|
|
Rel(SystemAA, SystemC, "Sends e-mails", "SMTP")
|
|
Rel(SystemC, customerA, "Sends e-mails to")
|
|
|
|
UpdateElementStyle(customerA, $fontColor="red", $bgColor="grey", $borderColor="red")
|
|
UpdateRelStyle(customerA, SystemAA, $textColor="blue", $lineColor="blue", $offsetX="5")
|
|
UpdateRelStyle(SystemAA, SystemE, $textColor="blue", $lineColor="blue", $offsetY="-10")
|
|
UpdateRelStyle(SystemAA, SystemC, $textColor="blue", $lineColor="blue", $offsetY="-40", $offsetX="-50")
|
|
UpdateRelStyle(SystemC, customerA, $textColor="red", $lineColor="red", $offsetX="-50", $offsetY="20")
|
|
|
|
UpdateLayoutConfig($c4ShapeInRow="3", $c4BoundaryInRow="1")</pre>
|
|
<h3 id="mindmaps">Mindmaps</h3>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="s">```mermaid
|
|
</span></span></span><span class="line"><span class="cl"><span class="s"></span>mindmap
|
|
</span></span><span class="line"><span class="cl"> root((mindmap))
|
|
</span></span><span class="line"><span class="cl"> Origins
|
|
</span></span><span class="line"><span class="cl"> Long history
|
|
</span></span><span class="line"><span class="cl"> ::icon(fa fa-book)
|
|
</span></span><span class="line"><span class="cl"> Popularisation
|
|
</span></span><span class="line"><span class="cl"> British popular psychology author Tony Buzan
|
|
</span></span><span class="line"><span class="cl"> Research
|
|
</span></span><span class="line"><span class="cl"> On effectiveness<br/>and features
|
|
</span></span><span class="line"><span class="cl"> On Automatic creation
|
|
</span></span><span class="line"><span class="cl"> Uses
|
|
</span></span><span class="line"><span class="cl"> Creative techniques
|
|
</span></span><span class="line"><span class="cl"> Strategic planning
|
|
</span></span><span class="line"><span class="cl"> Argument mapping
|
|
</span></span><span class="line"><span class="cl"> Tools
|
|
</span></span><span class="line"><span class="cl"> Pen and paper
|
|
</span></span><span class="line"><span class="cl"> Mermaid
|
|
</span></span><span class="line"><span class="cl"><span class="s">```</span></span></span></code></pre></div>
|
|
<pre class="mermaid align-center zoomable">mindmap
|
|
root((mindmap))
|
|
Origins
|
|
Long history
|
|
::icon(fa fa-book)
|
|
Popularisation
|
|
British popular psychology author Tony Buzan
|
|
Research
|
|
On effectiveness<br/>and features
|
|
On Automatic creation
|
|
Uses
|
|
Creative techniques
|
|
Strategic planning
|
|
Argument mapping
|
|
Tools
|
|
Pen and paper
|
|
Mermaid</pre>
|
|
<h3 id="timeline">Timeline</h3>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="s">```mermaid
|
|
</span></span></span><span class="line"><span class="cl"><span class="s"></span>timeline
|
|
</span></span><span class="line"><span class="cl"> title History of Social Media Platform
|
|
</span></span><span class="line"><span class="cl"> 2002 : LinkedIn
|
|
</span></span><span class="line"><span class="cl"> 2004 : Facebook
|
|
</span></span><span class="line"><span class="cl"> : Google
|
|
</span></span><span class="line"><span class="cl"> 2005 : Youtube
|
|
</span></span><span class="line"><span class="cl"> 2006 : Twitter
|
|
</span></span><span class="line"><span class="cl"><span class="s">```</span></span></span></code></pre></div>
|
|
<pre class="mermaid align-center zoomable">timeline
|
|
title History of Social Media Platform
|
|
2002 : LinkedIn
|
|
2004 : Facebook
|
|
: Google
|
|
2005 : Youtube
|
|
2006 : Twitter</pre>
|
|
<h3 id="sankey">Sankey</h3>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="s">```mermaid
|
|
</span></span></span><span class="line"><span class="cl"><span class="s"></span>sankey-beta
|
|
</span></span><span class="line"><span class="cl"> %% source,target,value
|
|
</span></span><span class="line"><span class="cl"> Electricity grid,Over generation / exports,104.453
|
|
</span></span><span class="line"><span class="cl"> Electricity grid,Heating and cooling - homes,113.726
|
|
</span></span><span class="line"><span class="cl"> Electricity grid,H2 conversion,27.14
|
|
</span></span><span class="line"><span class="cl"><span class="s">```</span></span></span></code></pre></div>
|
|
<pre class="mermaid align-center zoomable">sankey-beta
|
|
%% source,target,value
|
|
Electricity grid,Over generation / exports,104.453
|
|
Electricity grid,Heating and cooling - homes,113.726
|
|
Electricity grid,H2 conversion,27.14</pre>
|
|
<h3 id="xychart">XYChart</h3>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="s">```mermaid
|
|
</span></span></span><span class="line"><span class="cl"><span class="s"></span>xychart-beta
|
|
</span></span><span class="line"><span class="cl"> title "Sales Revenue"
|
|
</span></span><span class="line"><span class="cl"> x-axis [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec]
|
|
</span></span><span class="line"><span class="cl"> y-axis "Revenue (in $)" 4000 --> 11000
|
|
</span></span><span class="line"><span class="cl"> bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
|
|
</span></span><span class="line"><span class="cl"> line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
|
|
</span></span><span class="line"><span class="cl"><span class="s">```</span></span></span></code></pre></div>
|
|
<pre class="mermaid align-center zoomable">xychart-beta
|
|
title "Sales Revenue"
|
|
x-axis [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec]
|
|
y-axis "Revenue (in $)" 4000 --> 11000
|
|
bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
|
|
line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]</pre>
|
|
<h3 id="block-diagram">Block Diagram</h3>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="s">```mermaid
|
|
</span></span></span><span class="line"><span class="cl"><span class="s"></span>block-beta
|
|
</span></span><span class="line"><span class="cl"> columns 1
|
|
</span></span><span class="line"><span class="cl"> db(("DB"))
|
|
</span></span><span class="line"><span class="cl"> blockArrowId6<["&nbsp;&nbsp;&nbsp;"]>(down)
|
|
</span></span><span class="line"><span class="cl"> block:ID
|
|
</span></span><span class="line"><span class="cl"> A
|
|
</span></span><span class="line"><span class="cl"> B["A wide one in the middle"]
|
|
</span></span><span class="line"><span class="cl"> C
|
|
</span></span><span class="line"><span class="cl"> end
|
|
</span></span><span class="line"><span class="cl"> space
|
|
</span></span><span class="line"><span class="cl"> D
|
|
</span></span><span class="line"><span class="cl"> ID --> D
|
|
</span></span><span class="line"><span class="cl"> C --> D
|
|
</span></span><span class="line"><span class="cl"> style B fill:#969,stroke:#333,stroke-width:4px
|
|
</span></span><span class="line"><span class="cl"><span class="s">```</span></span></span></code></pre></div>
|
|
<pre class="mermaid align-center zoomable">block-beta
|
|
columns 1
|
|
db(("DB"))
|
|
blockArrowId6<["&nbsp;&nbsp;&nbsp;"]>(down)
|
|
block:ID
|
|
A
|
|
B["A wide one in the middle"]
|
|
C
|
|
end
|
|
space
|
|
D
|
|
ID --> D
|
|
C --> D
|
|
style B fill:#969,stroke:#333,stroke-width:4px</pre>
|
|
<h3 id="packet">Packet</h3>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="s">```mermaid
|
|
</span></span></span><span class="line"><span class="cl"><span class="s"></span>---
|
|
</span></span><span class="line"><span class="cl">title: "TCP Packet"
|
|
</span></span><span class="line"><span class="cl">---
|
|
</span></span><span class="line"><span class="cl">packet-beta
|
|
</span></span><span class="line"><span class="cl"> 0-15: "Source Port"
|
|
</span></span><span class="line"><span class="cl"> 16-31: "Destination Port"
|
|
</span></span><span class="line"><span class="cl"> 32-63: "Sequence Number"
|
|
</span></span><span class="line"><span class="cl"> 64-95: "Acknowledgment Number"
|
|
</span></span><span class="line"><span class="cl"> 96-99: "Data Offset"
|
|
</span></span><span class="line"><span class="cl"> 100-105: "Reserved"
|
|
</span></span><span class="line"><span class="cl"> 106: "URG"
|
|
</span></span><span class="line"><span class="cl"> 107: "ACK"
|
|
</span></span><span class="line"><span class="cl"> 108: "PSH"
|
|
</span></span><span class="line"><span class="cl"> 109: "RST"
|
|
</span></span><span class="line"><span class="cl"> 110: "SYN"
|
|
</span></span><span class="line"><span class="cl"> 111: "FIN"
|
|
</span></span><span class="line"><span class="cl"> 112-127: "Window"
|
|
</span></span><span class="line"><span class="cl"> 128-143: "Checksum"
|
|
</span></span><span class="line"><span class="cl"> 144-159: "Urgent Pointer"
|
|
</span></span><span class="line"><span class="cl"> 160-191: "(Options and Padding)"
|
|
</span></span><span class="line"><span class="cl"> 192-255: "Data (variable length)"
|
|
</span></span><span class="line"><span class="cl"><span class="s">```</span></span></span></code></pre></div>
|
|
<pre class="mermaid align-center zoomable">---
|
|
title: "TCP Packet"
|
|
---
|
|
packet-beta
|
|
0-15: "Source Port"
|
|
16-31: "Destination Port"
|
|
32-63: "Sequence Number"
|
|
64-95: "Acknowledgment Number"
|
|
96-99: "Data Offset"
|
|
100-105: "Reserved"
|
|
106: "URG"
|
|
107: "ACK"
|
|
108: "PSH"
|
|
109: "RST"
|
|
110: "SYN"
|
|
111: "FIN"
|
|
112-127: "Window"
|
|
128-143: "Checksum"
|
|
144-159: "Urgent Pointer"
|
|
160-191: "(Options and Padding)"
|
|
192-255: "Data (variable length)"</pre>
|
|
<h3 id="architecture">Architecture</h3>
|
|
<div class="highlight wrap-code"><pre tabindex="0" class="chroma"><code class="language-md" data-lang="md"><span class="line"><span class="cl"><span class="s">```mermaid
|
|
</span></span></span><span class="line"><span class="cl"><span class="s"></span>architecture-beta
|
|
</span></span><span class="line"><span class="cl"> group api(cloud)[API]
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> service db(database)[Database] in api
|
|
</span></span><span class="line"><span class="cl"> service disk1(disk)[Storage] in api
|
|
</span></span><span class="line"><span class="cl"> service disk2(disk)[Storage] in api
|
|
</span></span><span class="line"><span class="cl"> service server(server)[Server] in api
|
|
</span></span><span class="line"><span class="cl">
|
|
</span></span><span class="line"><span class="cl"> db:L -- R:server
|
|
</span></span><span class="line"><span class="cl"> disk1:T -- B:server
|
|
</span></span><span class="line"><span class="cl"> disk2:T -- B:db
|
|
</span></span><span class="line"><span class="cl"><span class="s">```</span></span></span></code></pre></div>
|
|
<pre class="mermaid align-center zoomable">architecture-beta
|
|
group api(cloud)[API]
|
|
|
|
service db(database)[Database] in api
|
|
service disk1(disk)[Storage] in api
|
|
service disk2(disk)[Storage] in api
|
|
service server(server)[Server] in api
|
|
|
|
db:L -- R:server
|
|
disk1:T -- B:server
|
|
disk2:T -- B:db</pre>
|
|
|
|
<footer class="footline">
|
|
<div class="R-taxonomy taxonomy-categories cstyle" title="Categories" style="--VARIABLE-TAGS-BG-color: var(--INTERNAL-TAG-BG-color);">
|
|
<i class="fa-fw fas fa-layer-group"></i>
|
|
<ul>
|
|
<li><a class="term-link" href="/hugo-theme-relearn/categories/howto/index.html">Howto</a></li>
|
|
<li><a class="term-link" href="/hugo-theme-relearn/categories/reference/index.html">Reference</a></li>
|
|
</ul>
|
|
</div>
|
|
</footer>
|
|
</article>
|
|
</div>
|
|
</main>
|
|
</div>
|
|
<aside id="R-sidebar" class="default-animation showVisitedLinks">
|
|
<div id="R-header-topbar" class="default-animation"></div>
|
|
<div id="R-header-wrapper" class="default-animation">
|
|
<div id="R-header" class="default-animation">
|
|
<style>
|
|
a#R-logo {
|
|
font-size: 1.875rem;
|
|
margin-top: -.8125rem;
|
|
max-width: 60%;
|
|
width: 14.125rem;
|
|
}
|
|
@media only all and (max-width: 59.999rem) {
|
|
a#R-logo {
|
|
font-size: 1.5625rem;
|
|
margin-top: -.1875rem;
|
|
}
|
|
}
|
|
#R-logo svg,
|
|
#R-logo svg * {
|
|
opacity: .945;
|
|
}
|
|
#R-logo svg {
|
|
margin-bottom: -1.25rem;
|
|
margin-inline-start: -1.47rem;
|
|
margin-inline-end: .5rem;
|
|
width: 40.5%;
|
|
}
|
|
@media only all and (max-width: 59.999rem) {
|
|
#R-logo svg {
|
|
margin-bottom: -.75rem;
|
|
margin-inline-start: -1.47rem;
|
|
margin-inline-end: .5rem;
|
|
}
|
|
}
|
|
</style>
|
|
<a id="R-logo" href="/hugo-theme-relearn/index.html">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64.044 64.044">
|
|
<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 0 1-.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.255.809.239 1.706.724 2.068 1.843.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 0 1-.499 1.309 1.757 1.757 0 0 1-.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 0 1-.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 0 0-.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:#282828;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 0 0 .303-.437.175.175 0 0 0 .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 0 0 .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:#282828;fill-opacity:1;stroke:none;stroke-width:.992837;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" transform="translate(-40.698 -95.175)"/>
|
|
<path d="M83.128 98.116c-.484 1.875-1.057 3.757-2.486 5.033-.638.57-1.13.666-1.483.548-.401-.134-.715-.506-1.058-.973-.338-.461-.655-.97-1.076-1.332-.192-.165-.404-.315-.683-.38-.279-.066-.599-.02-.9.102-.489.196-.89.58-1.28 1.047a6.1 6.1 0 0 0-.985 1.632c-.234.591-.356 1.174-.277 1.713.072.487.392.977.905 1.185.463.187.926.156 1.36.154.433 0 .843.01 1.242.147.55.189.79.736.822 1.368.034.66-.145 1.412-.393 1.988l-.008.021c-.74 1.705-1.946 2.893-3.004 4.349l-.664.915.979.099c.924.092 1.788.26 2.468.675.46.281 1.806 1.205 2.794 2.222.497.513.888 1.031 1.047 1.502.078.231.095.422.05.6a.93.93 0 0 1-.345.474c-.301.223-.606.395-.864.532l-.354.186c-.107.058-.189.087-.345.228a.637.637 0 0 1 .062-.045l-.064.041-.209.236-.103.343s.003.126.007.152c.003.017.003.007.004.015v.002c.016.195.061.307.133.476a4.1 4.1 0 0 0 .32.596 5.7 5.7 0 0 0 2.8 2.258c.284.108.908.321 1.548.36.33.02.59.015.912-.13h.002c.08-.037.228-.095.382-.281.153-.186.19-.355.212-.445l.019-.075.003-.078c.023-.585-.037-1.296.072-1.899.153-.657.435-.956 1.009-.909 2.771.239 4.74 1.955 6.693 3.83l.742.714.279-1.155c.55-2.29 1.093-4.464 2.928-5.977.692-.57 1.184-.642 1.527-.509.39.151.676.536.996.995.319.458.605.926 1.07 1.212.194.119.464.232.784.209.32-.024.638-.163.988-.384 1.022-.645 1.778-1.756 2.086-2.942.136-.522.102-.991-.046-1.301-.158-.334-.433-.553-.754-.707-.653-.314-1.468-.373-2.094-.486-.825-.15-1.22-.475-1.345-.878-.13-.417 0-.953.335-1.61.6-1.173 1.887-2.602 3.13-3.911l.498-.526-.449-.432c-1.545-1.49-3.163-3.01-5.252-3.715h-.002c-.473-.16-1.097-.413-1.73-.424h-.003c-.311-.004-.596.04-.883.24v.002c-.22.155-.483.537-.583.937l-.008.036-.006.038c-.116.773-.06 1.467-.217 1.995-.063.212-.198.418-.359.507-.202.111-.492.153-.976.072-.582-.097-1.978-.69-3.021-1.503-.523-.407-.934-.85-1.117-1.3a1.153 1.153 0 0 1-.083-.63c.03-.184.1-.477.308-.593.21-.116.941-.32 1.377-.642h.002c.192-.141.403-.367.518-.64.114-.275.127-.526.123-.774-.006-.142-.036-.192-.08-.3a8.417 8.417 0 0 0-3-3.027c-1.226-.725-2.585-1.135-3.927-1.539-.434-.12-.844-.111-1.02.466zm.912.947c1.186.364 2.357.718 3.345 1.303 1.035.612 1.864 1.488 2.507 2.528-.514.263-1.095.5-1.44.79-.345.29-.729.914-.815 1.434-.084.509 0 .968.155 1.347.301.74.85 1.276 1.44 1.735 1.18.92 2.554 1.545 3.47 1.698.604.1 1.186.088 1.739-.216.594-.327.935-.911 1.088-1.427.264-.884.193-1.664.262-2.17h.1c.3.006.926.206 1.417.371 1.646.554 3.044 1.773 4.431 3.089-1.102 1.174-2.222 2.423-2.888 3.73-.42.823-.73 1.789-.453 2.687.283.913 1.1 1.415 2.138 1.603.691.126 1.472.226 1.84.403.19.091.258.182.278.223.03.064.058.075-.023.387-.21.804-.761 1.598-1.413 2.01-.247.155-.365.183-.407.187-.042.003-.061.002-.172-.066-.144-.088-.455-.473-.772-.929-.317-.454-.714-1.07-1.452-1.356-.783-.304-1.776-.022-2.713.75-1.942 1.6-2.626 3.764-3.146 5.8-1.802-1.676-3.772-3.138-6.589-3.517h-.002c-.346-.095-1.013-.031-1.293.143-.735.501-1.005 1.132-1.168 2.007-.125.69-.082 1.216-.074 1.659-.055.006-.046.01-.104.006-.42-.026-1.035-.215-1.244-.295-.947-.361-1.774-1.006-2.314-1.857-.054-.085-.072-.132-.109-.2l.027-.016c.284-.15.656-.36 1.045-.648.44-.327.789-.798.93-1.35a2.4 2.4 0 0 0-.068-1.379c-.254-.751-.753-1.353-1.295-1.911-1.09-1.124-2.452-2.049-2.99-2.378-.609-.372-1.303-.44-1.981-.56.875-1.094 1.878-2.251 2.596-3.921.294-.823.543-1.907.513-2.658-.049-.97-.489-2.013-1.52-2.367-.579-.2-1.131-.204-1.58-.203-.45.002-.786-.006-.97-.08h-.002c-.264-.107-.236-.108-.268-.33-.025-.17.021-.553.183-.962a4.67 4.67 0 0 1 .725-1.192c.29-.348.617-.59.705-.626.142-.057.176-.05.22-.04.045.011.127.052.263.17.235.201.56.671.92 1.161.354.484.791 1.08 1.543 1.33.8.267 1.784-.052 2.671-.846 1.594-1.424 2.235-3.317 2.714-5.051zm11.705 7.023c-.02.014.042-.002.042 0l-.008.035c.05-.2-.028-.04-.034-.035zM79.472 122.45a.198.198 0 0 1 .005.023v.014c-.002-.01-.003-.03-.005-.037zm-.29.732-.006.01-.044.027c.016-.01.033-.024.05-.036z" style="color:#000;fill:#282828;stroke-width:1.02352;-inkscape-stroke:none" transform="translate(-40.698 -95.175)"/>
|
|
<path d="M76.694 128.845c-.85-.012-1.668.253-2.434.67-.01.592-.015 1.17.109 1.772.323 1.573.422 3.553-.07 5.147-.247.804-.684 1.535-1.347 1.891-.663.356-1.467.296-2.362-.159-.522-.266-1.059-.62-1.487-.757-.223-.072-.392-.096-.522-.069-.13.027-.232.094-.362.27-.53.719-.681 1.823-.497 2.876.177 1.012.418 1.438.543 1.56.143.137.26.154.604.055.548-.158 1.523-.857 2.573-.972l.02-.002.5.058c.686.081 1.247.562 1.622 1.19.372.62.591 1.37.73 2.136.279 1.532.25 3.16.083 4.232-.14.91-.394 1.72-.632 2.53 1.719-.385 3.485-.692 5.307-.36 1.174.214 2.749.574 3.762 1.977l.088.122.046.159c.162.551.16 1.114.024 1.578-.13.45-.348.772-.533 1.023-.181.246-.336.444-.437.606-.102.16-.141.275-.145.336-.01.17 0 .197.07.315.057.1.186.242.39.366.408.246 1.106.414 1.843.45a7.842 7.842 0 0 0 2.174-.21 4.28 4.28 0 0 0 .822-.296c.218-.106.385-.242.377-.233l.029-.031c.025-.035.05-.072.05-.068 0-.004 0-.017-.003-.05a2.733 2.733 0 0 0-.21-.579c-.26-.548-.839-1.333-.822-2.46.01-.657.27-1.21.598-1.576.32-.357.696-.575 1.074-.736.759-.323 1.57-.418 2.054-.458 1.653-.136 3.252.296 4.755.765.457.142.905.29 1.352.434.325-2.258.902-4.247.598-6.217-.071-.46-.25-1.169-.486-1.684-.238-.518-.495-.762-.675-.779-.351-.032-.716.14-1.174.418-.457.277-1.005.665-1.695.742-.745.082-1.406-.291-1.84-.908-.428-.608-.653-1.394-.754-2.196-.203-1.596.016-3.377.794-4.493.568-.813 1.358-.984 2.024-.835.65.146 1.243.51 1.769.779.524.267.99.413 1.237.365a.527.527 0 0 0 .346-.2c.11-.132.235-.373.37-.798.612-1.918.27-3.894-.246-6.054-2.815-.851-5.49-1.534-8.089-.267a.727.727 0 0 0-.223.148c-.024.028-.018.021-.026.056.001-.003-.01.178.07.44.162.522.611 1.29.911 1.978l.004.009.029.063.024.084V133c.162.635.016 1.297-.274 1.727-.272.404-.618.636-.952.81-.675.353-1.399.484-1.724.533a5.888 5.888 0 0 1-3.973-.795c-.512-.311-.876-.594-1.133-1.02-.282-.466-.318-1.084-.172-1.557.252-.814.715-1.266.971-1.89a.663.663 0 0 0 .047-.14c.001-.013 0-.006-.007-.037a.761.761 0 0 0-.184-.268c-.264-.267-.865-.595-1.54-.826-1.356-.462-3.07-.659-3.583-.686-.062-.002-.121-.006-.178-.006z" style="fill:#282828;fill-opacity:1;stroke:none;stroke-width:.991342;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" transform="translate(-40.698 -95.175)"/>
|
|
</svg>Relearn
|
|
</a>
|
|
</div>
|
|
<script>
|
|
window.index_js_url="/hugo-theme-relearn/searchindex.en.js?1729784203";
|
|
</script>
|
|
<search><form action="/hugo-theme-relearn/search/index.html" method="get">
|
|
<div class="searchbox default-animation">
|
|
<button class="search-detail" type="submit" title="Search (CTRL+ALT+f)"><i class="fas fa-search"></i></button>
|
|
<label class="a11y-only" for="R-search-by">Search</label>
|
|
<input data-search-input id="R-search-by" name="search-by" class="search-by" type="search" placeholder="Search...">
|
|
<button class="search-clear" type="button" data-search-clear="" title="Clear search"><i class="fas fa-times" title="Clear search"></i></button>
|
|
</div>
|
|
</form></search>
|
|
<script>
|
|
var contentLangs=['en'];
|
|
</script>
|
|
<script src="/hugo-theme-relearn/js/auto-complete.js?1729784203" defer></script>
|
|
<script src="/hugo-theme-relearn/js/lunr/lunr.min.js?1729784203" defer></script>
|
|
<script src="/hugo-theme-relearn/js/lunr/lunr.stemmer.support.min.js?1729784203" defer></script>
|
|
<script src="/hugo-theme-relearn/js/lunr/lunr.multi.min.js?1729784203" defer></script>
|
|
<script src="/hugo-theme-relearn/js/lunr/lunr.en.min.js?1729784203" defer></script>
|
|
<script src="/hugo-theme-relearn/js/search.js?1729784203" defer></script>
|
|
</div>
|
|
<div id="R-homelinks" class="default-animation">
|
|
<hr class="padding">
|
|
</div>
|
|
<div id="R-content-wrapper" class="highlightable">
|
|
<div id="R-shortcutmenu-home" class="R-sidebarmenu">
|
|
<ul class="enlarge morespace collapsible-menu">
|
|
<li class="" data-nav-id="/hugo-theme-relearn/introduction/index.html"><input type="checkbox" id="R-section-e1ed3a04f1f57a27be4a8d0eb274be18" aria-controls="R-subsections-e1ed3a04f1f57a27be4a8d0eb274be18"><label for="R-section-e1ed3a04f1f57a27be4a8d0eb274be18"><i class="fa-fw fas fa-chevron-down"></i><i class="fa-fw fas fa-chevron-right"></i><span class="a11y-only">Submenu Introduction</span></label><a class="padding" href="/hugo-theme-relearn/introduction/index.html"><i class='fa-fw fas fa-star'></i> Introduction<i class="fa-fw fas fa-check read-icon"></i></a><ul id="R-subsections-e1ed3a04f1f57a27be4a8d0eb274be18" class="collapsible-menu">
|
|
<li class="" data-nav-id="/hugo-theme-relearn/introduction/quickstart/index.html"><a class="padding" href="/hugo-theme-relearn/introduction/quickstart/index.html">Getting Started<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/introduction/tools/index.html"><a class="padding" href="/hugo-theme-relearn/introduction/tools/index.html">Tool Integration<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/introduction/releasenotes/index.html"><input type="checkbox" id="R-section-f5041d5a50403ef230e5b3d632ef5b5e" aria-controls="R-subsections-f5041d5a50403ef230e5b3d632ef5b5e"><label for="R-section-f5041d5a50403ef230e5b3d632ef5b5e"><i class="fa-fw fas fa-chevron-down"></i><i class="fa-fw fas fa-chevron-right"></i><span class="a11y-only">Submenu What's New</span></label><a class="padding" href="/hugo-theme-relearn/introduction/releasenotes/index.html">What's New<i class="fa-fw fas fa-check read-icon"></i></a><ul id="R-subsections-f5041d5a50403ef230e5b3d632ef5b5e" class="collapsible-menu">
|
|
<li class="" data-nav-id="/hugo-theme-relearn/introduction/releasenotes/5/index.html"><a class="padding" href="/hugo-theme-relearn/introduction/releasenotes/5/index.html">Version 5<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/introduction/releasenotes/4/index.html"><a class="padding" href="/hugo-theme-relearn/introduction/releasenotes/4/index.html">Version 4<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/introduction/releasenotes/3/index.html"><a class="padding" href="/hugo-theme-relearn/introduction/releasenotes/3/index.html">Version 3<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/introduction/releasenotes/2/index.html"><a class="padding" href="/hugo-theme-relearn/introduction/releasenotes/2/index.html">Version 2<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/introduction/releasenotes/1/index.html"><a class="padding" href="/hugo-theme-relearn/introduction/releasenotes/1/index.html">Version 1<i class="fa-fw fas fa-check read-icon"></i></a></li></ul></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/introduction/changelog/index.html"><input type="checkbox" id="R-section-4c8f9a0e787a57f2acea75c8c8f09920" aria-controls="R-subsections-4c8f9a0e787a57f2acea75c8c8f09920"><label for="R-section-4c8f9a0e787a57f2acea75c8c8f09920"><i class="fa-fw fas fa-chevron-down"></i><i class="fa-fw fas fa-chevron-right"></i><span class="a11y-only">Submenu Changelog</span></label><a class="padding" href="/hugo-theme-relearn/introduction/changelog/index.html">Changelog<i class="fa-fw fas fa-check read-icon"></i></a><ul id="R-subsections-4c8f9a0e787a57f2acea75c8c8f09920" class="collapsible-menu">
|
|
<li class="" data-nav-id="/hugo-theme-relearn/introduction/changelog/5/index.html"><a class="padding" href="/hugo-theme-relearn/introduction/changelog/5/index.html">Version 5<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/introduction/changelog/4/index.html"><a class="padding" href="/hugo-theme-relearn/introduction/changelog/4/index.html">Version 4<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/introduction/changelog/3/index.html"><a class="padding" href="/hugo-theme-relearn/introduction/changelog/3/index.html">Version 3<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/introduction/changelog/2/index.html"><a class="padding" href="/hugo-theme-relearn/introduction/changelog/2/index.html">Version 2<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/introduction/changelog/1/index.html"><a class="padding" href="/hugo-theme-relearn/introduction/changelog/1/index.html">Version 1<i class="fa-fw fas fa-check read-icon"></i></a></li></ul></li></ul></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/index.html"><input type="checkbox" id="R-section-6f6dce359ca8d596b5b1de1969a0aca2" aria-controls="R-subsections-6f6dce359ca8d596b5b1de1969a0aca2"><label for="R-section-6f6dce359ca8d596b5b1de1969a0aca2"><i class="fa-fw fas fa-chevron-down"></i><i class="fa-fw fas fa-chevron-right"></i><span class="a11y-only">Submenu Configuration</span></label><a class="padding" href="/hugo-theme-relearn/configuration/index.html"><i class='fa-fw fas fa-gears'></i> Configuration<i class="fa-fw fas fa-check read-icon"></i></a><ul id="R-subsections-6f6dce359ca8d596b5b1de1969a0aca2" class="collapsible-menu">
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/sitemanagement/index.html"><input type="checkbox" id="R-section-30019b7214c19b7e47568868fc6b6f47" aria-controls="R-subsections-30019b7214c19b7e47568868fc6b6f47"><label for="R-section-30019b7214c19b7e47568868fc6b6f47"><i class="fa-fw fas fa-chevron-down"></i><i class="fa-fw fas fa-chevron-right"></i><span class="a11y-only">Submenu Site Management</span></label><a class="padding" href="/hugo-theme-relearn/configuration/sitemanagement/index.html">Site Management<i class="fa-fw fas fa-check read-icon"></i></a><ul id="R-subsections-30019b7214c19b7e47568868fc6b6f47" class="collapsible-menu">
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/sitemanagement/structure/index.html"><a class="padding" href="/hugo-theme-relearn/configuration/sitemanagement/structure/index.html">Directory Structure<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/sitemanagement/multilingual/index.html"><a class="padding" href="/hugo-theme-relearn/configuration/sitemanagement/multilingual/index.html">Multilingual<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/sitemanagement/meta/index.html"><a class="padding" href="/hugo-theme-relearn/configuration/sitemanagement/meta/index.html">Meta Information<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/sitemanagement/deployment/index.html"><a class="padding" href="/hugo-theme-relearn/configuration/sitemanagement/deployment/index.html">Deployment Scenarios<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/sitemanagement/outputformats/index.html"><a class="padding" href="/hugo-theme-relearn/configuration/sitemanagement/outputformats/index.html">Available Output Formats<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/sitemanagement/stableoutput/index.html"><a class="padding" href="/hugo-theme-relearn/configuration/sitemanagement/stableoutput/index.html">Stable Output<i class="fa-fw fas fa-check read-icon"></i></a></li></ul></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/branding/index.html"><input type="checkbox" id="R-section-f4b18c0bbd92c3635c0cb3ea3fa97f55" aria-controls="R-subsections-f4b18c0bbd92c3635c0cb3ea3fa97f55"><label for="R-section-f4b18c0bbd92c3635c0cb3ea3fa97f55"><i class="fa-fw fas fa-chevron-down"></i><i class="fa-fw fas fa-chevron-right"></i><span class="a11y-only">Submenu Branding</span></label><a class="padding" href="/hugo-theme-relearn/configuration/branding/index.html">Branding<i class="fa-fw fas fa-check read-icon"></i></a><ul id="R-subsections-f4b18c0bbd92c3635c0cb3ea3fa97f55" class="collapsible-menu">
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/branding/logo/index.html"><a class="padding" href="/hugo-theme-relearn/configuration/branding/logo/index.html">Logo<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/branding/colors/index.html"><a class="padding" href="/hugo-theme-relearn/configuration/branding/colors/index.html">Colors<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/branding/modules/index.html"><a class="padding" href="/hugo-theme-relearn/configuration/branding/modules/index.html">Module Theming<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/branding/generator/index.html"><a class="padding" href="/hugo-theme-relearn/configuration/branding/generator/index.html">Stylesheet Generator<i class="fa-fw fas fa-check read-icon"></i></a></li></ul></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/sidebar/index.html"><input type="checkbox" id="R-section-8a12d8e45be5abcac33050ee02bdb0dc" aria-controls="R-subsections-8a12d8e45be5abcac33050ee02bdb0dc"><label for="R-section-8a12d8e45be5abcac33050ee02bdb0dc"><i class="fa-fw fas fa-chevron-down"></i><i class="fa-fw fas fa-chevron-right"></i><span class="a11y-only">Submenu Sidebar</span></label><a class="padding" href="/hugo-theme-relearn/configuration/sidebar/index.html">Sidebar<i class="fa-fw fas fa-check read-icon"></i></a><ul id="R-subsections-8a12d8e45be5abcac33050ee02bdb0dc" class="collapsible-menu">
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/sidebar/width/index.html"><a class="padding" href="/hugo-theme-relearn/configuration/sidebar/width/index.html">Width<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/sidebar/headerfooter/index.html"><a class="padding" href="/hugo-theme-relearn/configuration/sidebar/headerfooter/index.html">Header & Footer<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/sidebar/search/index.html"><a class="padding" href="/hugo-theme-relearn/configuration/sidebar/search/index.html">Search<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/sidebar/menus/index.html"><a class="padding" href="/hugo-theme-relearn/configuration/sidebar/menus/index.html">Menus<i class="fa-fw fas fa-check read-icon"></i></a></li></ul></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/content/index.html"><input type="checkbox" id="R-section-2a87e0c002948b04af017faf43e5f0cd" aria-controls="R-subsections-2a87e0c002948b04af017faf43e5f0cd"><label for="R-section-2a87e0c002948b04af017faf43e5f0cd"><i class="fa-fw fas fa-chevron-down"></i><i class="fa-fw fas fa-chevron-right"></i><span class="a11y-only">Submenu Content</span></label><a class="padding" href="/hugo-theme-relearn/configuration/content/index.html">Content<i class="fa-fw fas fa-check read-icon"></i></a><ul id="R-subsections-2a87e0c002948b04af017faf43e5f0cd" class="collapsible-menu">
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/content/width/index.html"><a class="padding" href="/hugo-theme-relearn/configuration/content/width/index.html">Width<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/content/titles/index.html"><a class="padding" href="/hugo-theme-relearn/configuration/content/titles/index.html">Titles & Breadcrumbs<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/content/headings/index.html"><a class="padding" href="/hugo-theme-relearn/configuration/content/headings/index.html">Headings<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/content/linking/index.html"><a class="padding" href="/hugo-theme-relearn/configuration/content/linking/index.html">Linking<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/content/hidden/index.html"><a class="padding" href="/hugo-theme-relearn/configuration/content/hidden/index.html">Hidden Pages<i class="fa-fw fas fa-check read-icon"></i></a></li></ul></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/customization/index.html"><input type="checkbox" id="R-section-19858c09ec2f1c50e3d9de05671968f7" aria-controls="R-subsections-19858c09ec2f1c50e3d9de05671968f7"><label for="R-section-19858c09ec2f1c50e3d9de05671968f7"><i class="fa-fw fas fa-chevron-down"></i><i class="fa-fw fas fa-chevron-right"></i><span class="a11y-only">Submenu Customization</span></label><a class="padding" href="/hugo-theme-relearn/configuration/customization/index.html">Customization<i class="fa-fw fas fa-check read-icon"></i></a><ul id="R-subsections-19858c09ec2f1c50e3d9de05671968f7" class="collapsible-menu">
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/customization/partials/index.html"><a class="padding" href="/hugo-theme-relearn/configuration/customization/partials/index.html">Partials<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/customization/dependencies/index.html"><a class="padding" href="/hugo-theme-relearn/configuration/customization/dependencies/index.html">Extending Scripts<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/customization/imageeffects/index.html"><a class="padding" href="/hugo-theme-relearn/configuration/customization/imageeffects/index.html">Image Effects<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/customization/topbar/index.html"><a class="padding" href="/hugo-theme-relearn/configuration/customization/topbar/index.html">Topbar<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/customization/designs/index.html"><a class="padding" href="/hugo-theme-relearn/configuration/customization/designs/index.html">Page Designs<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/customization/outputformats/index.html"><a class="padding" href="/hugo-theme-relearn/configuration/customization/outputformats/index.html">Output Formats<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/customization/taxonomy/index.html"><a class="padding" href="/hugo-theme-relearn/configuration/customization/taxonomy/index.html">Taxonomies<i class="fa-fw fas fa-check read-icon"></i></a></li></ul></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/configuration/reference/index.html"><a class="padding" href="/hugo-theme-relearn/configuration/reference/index.html">Options Reference<i class="fa-fw fas fa-check read-icon"></i></a></li></ul></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/authoring/index.html"><input type="checkbox" id="R-section-8b31cad8bcabec610b76d42ea98e772d" aria-controls="R-subsections-8b31cad8bcabec610b76d42ea98e772d"><label for="R-section-8b31cad8bcabec610b76d42ea98e772d"><i class="fa-fw fas fa-chevron-down"></i><i class="fa-fw fas fa-chevron-right"></i><span class="a11y-only">Submenu Authoring</span></label><a class="padding" href="/hugo-theme-relearn/authoring/index.html"><i class='fa-fw fab fa-markdown'></i> Authoring<i class="fa-fw fas fa-check read-icon"></i></a><ul id="R-subsections-8b31cad8bcabec610b76d42ea98e772d" class="collapsible-menu">
|
|
<li class="" data-nav-id="/hugo-theme-relearn/authoring/structure/index.html"><a class="padding" href="/hugo-theme-relearn/authoring/structure/index.html">Directory Structure<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/authoring/frontmatter/index.html"><input type="checkbox" id="R-section-825d31d37330c362736813c7d9e192f9" aria-controls="R-subsections-825d31d37330c362736813c7d9e192f9"><label for="R-section-825d31d37330c362736813c7d9e192f9"><i class="fa-fw fas fa-chevron-down"></i><i class="fa-fw fas fa-chevron-right"></i><span class="a11y-only">Submenu Front Matter</span></label><a class="padding" href="/hugo-theme-relearn/authoring/frontmatter/index.html">Front Matter<i class="fa-fw fas fa-check read-icon"></i></a><ul id="R-subsections-825d31d37330c362736813c7d9e192f9" class="collapsible-menu">
|
|
<li class="" data-nav-id="/hugo-theme-relearn/authoring/frontmatter/designs/index.html"><a class="padding" href="/hugo-theme-relearn/authoring/frontmatter/designs/index.html">Page Designs<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/authoring/frontmatter/menus/index.html"><a class="padding" href="/hugo-theme-relearn/authoring/frontmatter/menus/index.html">Menus<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/authoring/frontmatter/linking/index.html"><a class="padding" href="/hugo-theme-relearn/authoring/frontmatter/linking/index.html">Linking<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/authoring/frontmatter/topbar/index.html"><a class="padding" href="/hugo-theme-relearn/authoring/frontmatter/topbar/index.html">Topbar<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/authoring/frontmatter/reference/index.html"><a class="padding" href="/hugo-theme-relearn/authoring/frontmatter/reference/index.html">Reference<i class="fa-fw fas fa-check read-icon"></i></a></li></ul></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/authoring/meta/index.html"><a class="padding" href="/hugo-theme-relearn/authoring/meta/index.html">Meta Information<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/authoring/markdown/index.html"><a class="padding" href="/hugo-theme-relearn/authoring/markdown/index.html">Markdown Syntax<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/authoring/imageeffects/index.html"><a class="padding" href="/hugo-theme-relearn/authoring/imageeffects/index.html">Image Effects<i class="fa-fw fas fa-check read-icon"></i></a></li></ul></li>
|
|
<li class="parent " data-nav-id="/hugo-theme-relearn/shortcodes/index.html"><input type="checkbox" id="R-section-d1d72bec74e5a90c315283c9c8d23f10" aria-controls="R-subsections-d1d72bec74e5a90c315283c9c8d23f10" checked><label for="R-section-d1d72bec74e5a90c315283c9c8d23f10"><i class="fa-fw fas fa-chevron-down"></i><i class="fa-fw fas fa-chevron-right"></i><span class="a11y-only">Submenu Shortcodes</span></label><a class="padding" href="/hugo-theme-relearn/shortcodes/index.html"><i class='fa-fw fas fa-shapes'></i> Shortcodes<i class="fa-fw fas fa-check read-icon"></i></a><ul id="R-subsections-d1d72bec74e5a90c315283c9c8d23f10" class="collapsible-menu">
|
|
<li class="" data-nav-id="/hugo-theme-relearn/shortcodes/badge/index.html"><a class="padding" href="/hugo-theme-relearn/shortcodes/badge/index.html">Badge<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/shortcodes/button/index.html"><a class="padding" href="/hugo-theme-relearn/shortcodes/button/index.html">Button<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/shortcodes/children/index.html"><input type="checkbox" id="R-section-fe0c5ca44d2308c87cd4ce4b0f5b840c" aria-controls="R-subsections-fe0c5ca44d2308c87cd4ce4b0f5b840c"><label for="R-section-fe0c5ca44d2308c87cd4ce4b0f5b840c"><i class="fa-fw fas fa-chevron-down"></i><i class="fa-fw fas fa-chevron-right"></i><span class="a11y-only">Submenu Children</span></label><a class="padding" href="/hugo-theme-relearn/shortcodes/children/index.html">Children<i class="fa-fw fas fa-check read-icon"></i></a><ul id="R-subsections-fe0c5ca44d2308c87cd4ce4b0f5b840c" class="collapsible-menu">
|
|
<li class="" data-nav-id="/hugo-theme-relearn/shortcodes/children/test/index.html"><a class="padding" href="/hugo-theme-relearn/shortcodes/children/test/index.html">page X<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/shortcodes/children/children-1/index.html"><input type="checkbox" id="R-section-3a684958d7eda0d20aafd9ea9a702f88" aria-controls="R-subsections-3a684958d7eda0d20aafd9ea9a702f88"><label for="R-section-3a684958d7eda0d20aafd9ea9a702f88"><i class="fa-fw fas fa-chevron-down"></i><i class="fa-fw fas fa-chevron-right"></i><span class="a11y-only">Submenu page 1</span></label><a class="padding" href="/hugo-theme-relearn/shortcodes/children/children-1/index.html">page 1<i class="fa-fw fas fa-check read-icon"></i></a><ul id="R-subsections-3a684958d7eda0d20aafd9ea9a702f88" class="collapsible-menu">
|
|
<li class="alwaysopen " data-nav-id="/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/index.html"><input type="checkbox" id="R-section-2727dc6e08fcb96a079be91aa7704ea4" aria-controls="R-subsections-2727dc6e08fcb96a079be91aa7704ea4" checked><label for="R-section-2727dc6e08fcb96a079be91aa7704ea4"><i class="fa-fw fas fa-chevron-down"></i><i class="fa-fw fas fa-chevron-right"></i><span class="a11y-only">Submenu page 1-1</span></label><a class="padding" href="/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/index.html">page 1-1<i class="fa-fw fas fa-check read-icon"></i></a><ul id="R-subsections-2727dc6e08fcb96a079be91aa7704ea4" class="collapsible-menu">
|
|
<li class="headless alwaysopen " data-nav-id=""><input type="checkbox" id="R-section-c58ec1ea7ddbdef134eb892a5c569711" aria-controls="R-subsections-c58ec1ea7ddbdef134eb892a5c569711" checked><label for="R-section-c58ec1ea7ddbdef134eb892a5c569711"><i class="fa-fw fas fa-chevron-down"></i><i class="fa-fw fas fa-chevron-right"></i><span class="a11y-only">Submenu page 1-1-2 (headless)</span></label><span class="padding">page 1-1-2 (headless)</span><ul id="R-subsections-c58ec1ea7ddbdef134eb892a5c569711" class="collapsible-menu">
|
|
<li class="" data-nav-id="/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html"><a class="padding" href="/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/index.html">page 1-1-2-1<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html"><a class="padding" href="/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/index.html">page 1-1-2-2<i class="fa-fw fas fa-check read-icon"></i></a></li></ul></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html"><a class="padding" href="/hugo-theme-relearn/shortcodes/children/children-1/children-1-1/children-1-1-3/index.html">page 1-1-3<i class="fa-fw fas fa-check read-icon"></i></a></li></ul></li></ul></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/shortcodes/children/children-2/index.html"><a class="padding" href="/hugo-theme-relearn/shortcodes/children/children-2/index.html">page 2<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/shortcodes/children/children-3/index.html"><input type="checkbox" id="R-section-f00fb288327406c804f8936fa36d260b" aria-controls="R-subsections-f00fb288327406c804f8936fa36d260b"><label for="R-section-f00fb288327406c804f8936fa36d260b"><i class="fa-fw fas fa-chevron-down"></i><i class="fa-fw fas fa-chevron-right"></i><span class="a11y-only">Submenu page 3</span></label><a class="padding" href="/hugo-theme-relearn/shortcodes/children/children-3/index.html">page 3<i class="fa-fw fas fa-check read-icon"></i></a><ul id="R-subsections-f00fb288327406c804f8936fa36d260b" class="collapsible-menu">
|
|
<li class="" data-nav-id="/hugo-theme-relearn/shortcodes/children/children-3/test3/index.html"><a class="padding" href="/hugo-theme-relearn/shortcodes/children/children-3/test3/index.html">page 3-1<i class="fa-fw fas fa-check read-icon"></i></a></li></ul></li></ul></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/shortcodes/expand/index.html"><a class="padding" href="/hugo-theme-relearn/shortcodes/expand/index.html">Expand<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/shortcodes/highlight/index.html"><a class="padding" href="/hugo-theme-relearn/shortcodes/highlight/index.html">Highlight<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/shortcodes/icon/index.html"><a class="padding" href="/hugo-theme-relearn/shortcodes/icon/index.html">Icon<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/shortcodes/include/index.html"><a class="padding" href="/hugo-theme-relearn/shortcodes/include/index.html">Include<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/shortcodes/math/index.html"><a class="padding" href="/hugo-theme-relearn/shortcodes/math/index.html">Math<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="active " data-nav-id="/hugo-theme-relearn/shortcodes/mermaid/index.html"><a class="padding" href="/hugo-theme-relearn/shortcodes/mermaid/index.html">Mermaid<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/shortcodes/notice/index.html"><a class="padding" href="/hugo-theme-relearn/shortcodes/notice/index.html">Notice<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/shortcodes/openapi/index.html"><a class="padding" href="/hugo-theme-relearn/shortcodes/openapi/index.html">OpenAPI<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/shortcodes/resources/index.html"><a class="padding" href="/hugo-theme-relearn/shortcodes/resources/index.html">Resources<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/shortcodes/siteparam/index.html"><a class="padding" href="/hugo-theme-relearn/shortcodes/siteparam/index.html">SiteParam<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/shortcodes/tab/index.html"><a class="padding" href="/hugo-theme-relearn/shortcodes/tab/index.html">Tab<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/shortcodes/tabs/index.html"><a class="padding" href="/hugo-theme-relearn/shortcodes/tabs/index.html">Tabs<i class="fa-fw fas fa-check read-icon"></i></a></li></ul></li>
|
|
</ul>
|
|
</div>
|
|
<div id="R-shortcutmenu-shortcuts" class="R-sidebarmenu">
|
|
<div class="nav-title padding">More</div>
|
|
<ul class="space collapsible-menu">
|
|
<li class="" data-nav-id="https://github.com/McShelby/hugo-theme-relearn"><a class="padding" href="https://github.com/McShelby/hugo-theme-relearn"><i class="fa-fw fab fa-github"></i> GitHub Repo<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/showcase/index.html"><a class="padding" href="/hugo-theme-relearn/showcase/index.html"><i class='fa-fw fas fa-camera'></i> Showcases<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/more/credits/index.html"><a class="padding" href="/hugo-theme-relearn/more/credits/index.html"><i class='fa-fw fas fa-bullhorn'></i> Credits<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/tags/index.html"><a class="padding" href="/hugo-theme-relearn/tags/index.html"><i class="fa-fw fas fa-tags"></i> Tags<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
<li class="" data-nav-id="/hugo-theme-relearn/categories/index.html"><a class="padding" href="/hugo-theme-relearn/categories/index.html"><i class="fa-fw fas fa-layer-group"></i> Categories<i class="fa-fw fas fa-check read-icon"></i></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="padding footermargin footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showLangSwitch showVariantSwitch showVisitedLinks showFooter"></div>
|
|
<div id="R-menu-footer">
|
|
<hr class="padding default-animation footerLangSwitch footerVariantSwitch footerVisitedLinks footerFooter showLangSwitch showVariantSwitch showVisitedLinks showFooter">
|
|
<div id="R-prefooter" class="footerLangSwitch footerVariantSwitch footerVisitedLinks showLangSwitch showVariantSwitch showVisitedLinks">
|
|
<ul>
|
|
<li id="R-select-language-container" class="footerLangSwitch showLangSwitch">
|
|
<div class="padding menu-control">
|
|
<i class="fa-fw fas fa-language"></i>
|
|
<span> </span>
|
|
<div class="control-style">
|
|
<label class="a11y-only" for="R-select-language">Language</label>
|
|
<select id="R-select-language" onchange="location = this.querySelector( this.value ).dataset.url;">
|
|
<option id="R-select-language-en" value="#R-select-language-en" data-url="/hugo-theme-relearn/shortcodes/mermaid/index.html" lang="en" selected>English</option>
|
|
<option id="R-select-language-pir" value="#R-select-language-pir" data-url="/hugo-theme-relearn/pir/shortcodes/mermaid/index.html" lang="art-x-pir">Arrr! ☠ Pirrratish ☠</option>
|
|
</select>
|
|
</div>
|
|
<div class="clear"></div>
|
|
</div>
|
|
</li>
|
|
<li id="R-select-variant-container" class="footerVariantSwitch showVariantSwitch">
|
|
<div class="padding menu-control">
|
|
<i class="fa-fw fas fa-paint-brush"></i>
|
|
<span> </span>
|
|
<div class="control-style">
|
|
<label class="a11y-only" for="R-select-variant">Theme</label>
|
|
<select id="R-select-variant" onchange="window.variants && variants.changeVariant( this.value );">
|
|
<option id="R-select-variant-relearn-auto" value="relearn-auto" selected>Relearn Light/Dark</option>
|
|
<option id="R-select-variant-relearn-light" value="relearn-light">Relearn Light</option>
|
|
<option id="R-select-variant-relearn-dark" value="relearn-dark">Relearn Dark</option>
|
|
<option id="R-select-variant-relearn-bright" value="relearn-bright">Relearn Bright</option>
|
|
<option id="R-select-variant-zen-auto" value="zen-auto">Zen Light/Dark</option>
|
|
<option id="R-select-variant-zen-light" value="zen-light">Zen Light</option>
|
|
<option id="R-select-variant-zen-dark" value="zen-dark">Zen Dark</option>
|
|
<option id="R-select-variant-retro-auto" value="retro-auto">Retro Learn/Neon</option>
|
|
<option id="R-select-variant-neon" value="neon">Neon</option>
|
|
<option id="R-select-variant-learn" value="learn">Learn</option>
|
|
<option id="R-select-variant-blue" value="blue">Blue</option>
|
|
<option id="R-select-variant-green" value="green">Green</option>
|
|
<option id="R-select-variant-red" value="red">Red</option>
|
|
</select>
|
|
</div>
|
|
<div class="clear"></div>
|
|
</div>
|
|
<script>window.variants && variants.markSelectedVariant();</script>
|
|
</li>
|
|
<li class="footerVisitedLinks showVisitedLinks">
|
|
<div class="padding menu-control">
|
|
<i class="fa-fw fas fa-history"></i>
|
|
<span> </span>
|
|
<div class="control-style">
|
|
<button onclick="clearHistory();">Clear History</button>
|
|
</div>
|
|
<div class="clear"></div>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="R-footer" class="footerFooter showFooter">
|
|
<span class="github-buttons"></span>
|
|
<p>Built with <a href="https://github.com/McShelby/hugo-theme-relearn" title="love"><i class="fas fa-heart"></i></a> by <a href="https://gohugo.io/">Hugo</a></p>
|
|
<script>
|
|
function githubButtonsScheme(){
|
|
var scheme = 'light';
|
|
var colorPropertyValue = window.getComputedStyle( document.querySelector( '#R-sidebar' ) ).getPropertyValue( 'background-color' );
|
|
var colorValues = colorPropertyValue.match( /\d+/g ).map( function( e ){ return parseInt(e,10); });
|
|
if( colorValues.length === 3 && ((0.2126 * colorValues[0]) + (0.7152 * colorValues[1]) + (0.0722 * colorValues[2]) < 165) ){
|
|
scheme = 'dark';
|
|
}
|
|
return scheme;
|
|
}
|
|
function githubButtonsInit(){
|
|
if( !window.githubButtons ){
|
|
setTimeout( githubButtonsInit, 50 );
|
|
return;
|
|
}
|
|
var scheme = githubButtonsScheme();
|
|
var githubButtonsHTML = `
|
|
<a class="github-button" href="https://github.com/McShelby/hugo-theme-relearn/archive/main.zip" data-color-scheme="${scheme}" 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-color-scheme="${scheme}" 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-color-scheme="${scheme}" data-icon="octicon-repo-forked" data-show-count="true" aria-label="Fork McShelby/hugo-theme-relearn on GitHub">Fork</a>
|
|
`;
|
|
document.querySelector( '.github-buttons' ).innerHTML = githubButtonsHTML;
|
|
document.querySelectorAll( '.github-button' ).forEach( function( anchor ){
|
|
anchor.dataset.colorScheme = scheme;
|
|
window.githubButtons.render( anchor, function( el ){
|
|
anchor.parentNode.replaceChild( el, anchor );
|
|
});
|
|
});
|
|
}
|
|
document.addEventListener( 'themeVariantLoaded', function( e ){
|
|
setTimeout( githubButtonsInit, 400 );
|
|
});
|
|
window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', event => {
|
|
setTimeout( githubButtonsInit, 400 );
|
|
});
|
|
</script>
|
|
<script async src="/hugo-theme-relearn/js/github-buttons.js?1729784203"></script>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</aside>
|
|
<script src="/hugo-theme-relearn/js/clipboard.min.js?1729784203" defer></script>
|
|
<script src="/hugo-theme-relearn/js/perfect-scrollbar.min.js?1729784203" defer></script>
|
|
<script src="/hugo-theme-relearn/js/d3/d3-color.min.js?1729784203" defer></script>
|
|
<script src="/hugo-theme-relearn/js/d3/d3-dispatch.min.js?1729784203" defer></script>
|
|
<script src="/hugo-theme-relearn/js/d3/d3-drag.min.js?1729784203" defer></script>
|
|
<script src="/hugo-theme-relearn/js/d3/d3-ease.min.js?1729784203" defer></script>
|
|
<script src="/hugo-theme-relearn/js/d3/d3-interpolate.min.js?1729784203" defer></script>
|
|
<script src="/hugo-theme-relearn/js/d3/d3-selection.min.js?1729784203" defer></script>
|
|
<script src="/hugo-theme-relearn/js/d3/d3-timer.min.js?1729784203" defer></script>
|
|
<script src="/hugo-theme-relearn/js/d3/d3-transition.min.js?1729784203" defer></script>
|
|
<script src="/hugo-theme-relearn/js/d3/d3-zoom.min.js?1729784203" defer></script>
|
|
<script src="/hugo-theme-relearn/js/js-yaml.min.js?1729784203" defer></script>
|
|
<script src="/hugo-theme-relearn/js/mermaid.min.js?1729784203" defer></script>
|
|
<script>
|
|
window.themeUseMermaid = JSON.parse("{ \"securityLevel\": \"loose\" }");
|
|
</script>
|
|
<script src="/hugo-theme-relearn/js/theme.js?1729784203" defer></script>
|
|
</body>
|
|
</html>
|