This commit is contained in:
JeremyVyska 2022-03-08 08:09:58 +00:00
parent 2f8078f0df
commit 34079491f7
203 changed files with 1121 additions and 782 deletions

View file

@ -23,7 +23,56 @@ end;
</span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span>Customer<span style="color:#ce5c00;font-weight:bold">.</span>Name<span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#ce5c00;font-weight:bold">:=</span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#4e9a06">'waldo'</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
</span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span>Customer<span style="color:#ce5c00;font-weight:bold">.</span><span style="color:#204a87;font-weight:bold">Modify</span><span style="color:#ce5c00;font-weight:bold">(</span>true<span style="color:#ce5c00;font-weight:bold">)</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
</span></span></span><span style="display:flex;"><span><span style="color:#f8f8f8;text-decoration:underline"> </span><span style="color:#204a87;font-weight:bold">end</span><span style="color:#000;font-weight:bold">;</span><span style="color:#f8f8f8;text-decoration:underline">
</span></span></span></code></pre></div><h2 id="hugo-shortcodes">Hugo Shortcodes</h2>
</span></span></span></code></pre></div><h2 id="diagrams-with-mermaid">Diagrams with Mermaid</h2>
<p>When providing a documentation, diagrams come in handy. <a href="https://mermaid-js.github.io/mermaid/#/">Mermaid</a> lets you create diagrams and visualizations using text and code.</p>
<p>For example the following markdown section:</p>
<pre tabindex="0"><code>```mermaid
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()
}
```
</code></pre><p>Results in:</p>
<pre tabindex="0"><code class="language-mermaid" data-lang="mermaid">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()
}
</code></pre><p>Can’t wait to get started? Use the Mermaid <a href="https://mermaid.live/edit">Live Editor</a>.</p>
<h2 id="hugo-shortcodes">Hugo Shortcodes</h2>
<p>Since we’re using “Hugo”, we can use it’s shortcode. Here is a reference: <a href="https://gohugo.io/content-management/shortcodes/">https://gohugo.io/content-management/shortcodes/</a></p>
<p>It basically means we are able to use easy notations to do cool things. Let’s point out some useful shortcodes:</p>
<h3 id="twitter">Twitter</h3>