Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mermaid Update #427

Merged
merged 6 commits into from
Feb 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,15 +260,13 @@ mermaid: default # Enable mermaid-js for diagrams, use theme: base, forest, dark
```

Find all the help you need on the official [mermaid documentation](https://mermaid-js.github.io/mermaid/).
You can create with ease diagrams. Add your mermaid script inside two mermaid divs (default Kramdown does not yet support mermaid).
With the `class="mermaid"` inside the `<div>`:
Use `mermaid` as color highlighter language to render the diagram or with the `class="mermaid"` inside the `<div>`:

```html
<div class="mermaid">
```markdown
```mermaid
sequenceDiagram
Alice->>John: Hello John, how are you?
John-->>Alice: Great!
</div>
```

### Social icons
Expand Down
18 changes: 12 additions & 6 deletions _includes/default/footer.liquid
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
<footer class="site-footer">
<p class="text">
{{ site.footer_text | default: "Powered by <a href='https://jekyllrb.com/'>Jekyll</a> with <a href='https://github.com/sylhare/Type-on-Strap'>Type on Strap</a>" }}</p>
<div class="footer-icons">
<ul>
<!-- Social icons from Font Awesome, if enabled -->
{% include social/icons.liquid %}
</ul>
</div>
<div class="footer-icons">
<ul>
<!-- Social icons from Font Awesome, if enabled -->
{% include social/icons.liquid %}
</ul>
</div>
{% if site.mermaid %}
<script type="module">
mermaid.initialize({ startOnLoad: false, theme: "default" });
mermaid.run({ nodes: [...document.querySelectorAll('.language-mermaid'), ...document.querySelectorAll('.mermaid')] });
</script>
{% endif %}
</footer>


7 changes: 2 additions & 5 deletions _includes/default/head.liquid
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,9 @@
<script defer src="{{ '/assets/js/vendor/katex.auto-render.min.js' | relative_url }}" onload="renderMathInElement(document.body);"></script>
{% endif %}

<!-- Mermaid 10.6.1 -->
<!-- Mermaid 10.8.0 -->
{% if site.mermaid %}
<script defer src="{{ '/assets/js/vendor/mermaid.min.js' | relative_url }}" onload="mermaid.initialize({
startOnLoad:true,
theme: '{{ site.mermaid }}',
});"></script>
<script defer src="{{ '/assets/js/vendor/mermaid.min.js' | relative_url }}"></script>
{% endif %}

<!-- Simple Jekyll Search 1.10.0 -->
Expand Down
56 changes: 33 additions & 23 deletions _posts/2016-12-03-Mermaid.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,17 @@ sequenceDiagram
</div>
```

> 💡 Now render also work with the GitHub markdown highlight.
{% highlight markdown %}
```mermaid
sequenceDiagram
Alice->>John: Hello John, how are you?
John-->>Alice: Great!
```
{% endhighlight %}
That will be rendered into this:

{% include aligner.html images="mermaid-example.png" column=1 %}
{% include aligner.html images="mermaid-example.png" column=auto %}

You can also go with more complex features and diagrams from the [documentation](https://mermaid-js.github.io/mermaid/),
and try it out with the [live editor](https://mermaid.live/).
Expand All @@ -43,18 +51,20 @@ sequenceDiagram

### Flow

<div class="mermaid">
```mermaid
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

<div class="mermaid"> is still supported, but I prefer the more markdown integrated way.

flowchart TD
A[Christmas] -->|Get money| B(Go shopping)
B --> C{Let me think}
C -->|One| D[Laptop]
D ~~~ E
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

new in 10.8.0 to align blocks

C -->|Two| E[iPhone]
C -->|Three| F[fa:fa-car Car]
</div>
%% Grinch
```

### Class

<div class="mermaid">
```mermaid
classDiagram
Animal <|-- Duck
Animal <|-- Fish
Expand All @@ -76,23 +86,23 @@ classDiagram
+bool is_wild
+run()
}
</div>
```

### State

<div class="mermaid">
```mermaid
stateDiagram-v2
[*] --> Still
Still --> [*]
Still --> Moving
Moving --> Still
Moving --> Crash
Crash --> [*]
</div>
```

### ER

<div class="mermaid">
```mermaid
erDiagram
CUSTOMER }|..|{ DELIVERY-ADDRESS : has
CUSTOMER ||--o{ ORDER : places
Expand All @@ -102,11 +112,11 @@ erDiagram
ORDER ||--|{ ORDER-ITEM : includes
PRODUCT-CATEGORY ||--|{ PRODUCT : contains
PRODUCT ||--o{ ORDER-ITEM : "ordered in"
</div>
```

### Gantt

<div class="mermaid">
```mermaid
gantt
title A Gantt Diagram
dateFormat YYYY-MM-DD
Expand All @@ -116,11 +126,11 @@ gantt
section Another
Task in sec :2014-01-12 , 12d
another task : 24d
</div>
```

### User Journey

<div class="mermaid">
```mermaid
journey
title My working day
section Go to work
Expand All @@ -130,11 +140,11 @@ journey
section Go home
Go downstairs: 5: Me
Sit down: 3: Me
</div>
```

### Git

<div class="mermaid">
```mermaid
gitGraph
commit
commit
Expand All @@ -146,20 +156,20 @@ gitGraph
merge develop
commit
commit
</div>
```

### Pie

<div class="mermaid">
```mermaid
pie title Pets adopted by volunteers
"Dogs" : 386
"Cats" : 85
"Rats" : 15
</div>
```

### Mindmap

<div class="mermaid">
```mermaid
mindmap
root((mindmap))
Origins
Expand All @@ -177,11 +187,11 @@ mindmap
Tools
Pen and paper
Mermaid
</div>
```

### QuadrantChart

<div class="mermaid">
```mermaid
quadrantChart
title Reach and engagement of campaigns
x-axis Low Reach --> High Reach
Expand All @@ -196,16 +206,16 @@ quadrantChart
Campaign D: [0.78, 0.34]
Campaign E: [0.40, 0.34]
Campaign F: [0.35, 0.78]
</div>
```

### XYChart

<div class="mermaid">
```mermaid
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]
</div>
```

2 changes: 1 addition & 1 deletion _sass/base/_global.scss
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ details {
}

// Mermaid
.mermaid {
.mermaid, .language-mermaid {
background-color: rgba(255, 255, 255, 0.9);
border-radius: 2%;

Expand Down
639 changes: 376 additions & 263 deletions assets/js/vendor/mermaid.min.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion type-on-strap.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
Thanks for using Type on strap v2+!
MSG

spec.required_ruby_version = ">= 2.7.4", "< 4.0"
spec.required_ruby_version = ">= 2.7.2", "< 4.0"

spec.add_runtime_dependency "jekyll", ">= 3.8", "< 5.0"
spec.add_runtime_dependency "jekyll-feed", ">= 0.15.1", "<= 0.17"
Expand Down
Loading