mermaid.jsを試してみる

mermaid.jsとは

mermaid.jsは、JavaScriptのライブラリで、テキストベースの独自の構文(Mermaid記法)を記述し、フローチャートやダイヤグラム、ガントチャートなど、複雑な図表をグラフィカルに表示できます。 GitHubやQiita、Notionなど、いろいろなサービスでも採用されています。今回は、hugoでmermaid.jsを使えるようにしてみます。

hugoでmermaid.jsを使えるようにする

手順は以下の通りです。

layouts/partials/extend_footer.htmlに以下を追加。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{{ if or .Params.mermaid .Site.Params.mermaid }}
<script src="https://cdn.jsdelivr.net/npm/mermaid@10.3.0/dist/mermaid.min.js"></script>
{{- $loadmermaid := resources.Get "js/load-mermaid.js" }}
<script src="{{ $loadmermaid.RelPermalink }}"></script>
<script>
    window.initMermaid();
    if (isDarkTheme()) {
        setPrefTheme('dark');
    } else {
        setPrefTheme('light');
    }
</script>
{{ end }}

※if文でmermaid: trueとした場合のみmermaid.min.jsを読み込むようにしています。このライブラリは3MBほどあり意外と大きい。

assets/js/load-mermaid.jsを作成。この処理は初期化および動的にテーマが切り替えられた際、再描画するために使われます。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
(function(window){
'use strict'

  const elementCode = '.mermaid'
  const loadMermaid = function(theme) {
    window.mermaid.initialize({theme})
    window.mermaid.init({theme}, document.querySelectorAll(elementCode))
  }
  const saveOriginalData = function(){
    return new Promise((resolve, reject) => {
      try {
        var els = document.querySelectorAll(elementCode),
            count = els.length;
        els.forEach(element => {
          element.setAttribute('data-original-code', element.innerHTML)
          count--
          if(count == 0){
            resolve()
          }
        });
      } catch (error) {
       reject(error) 
      }
    })
  }
  const resetProcessed = function(){
    return new Promise((resolve, reject) => {
      try {
        var els = document.querySelectorAll(elementCode),
            count = els.length;
        els.forEach(element => {
          if(element.getAttribute('data-original-code') != null){
            element.removeAttribute('data-processed')
            element.innerHTML = element.getAttribute('data-original-code')
          }
          count--
          if(count == 0){
            resolve()
          }
        });
      } catch (error) {
       reject(error) 
      }
    })
  } 

  const init = ()=>{
    saveOriginalData()
    .catch( console.error )
    document.body.addEventListener('dark-theme-set', ()=>{
      resetProcessed()
      .then(loadMermaid('dark'))
      .catch(console.error)
    })
    document.body.addEventListener('light-theme-set', ()=>{
      resetProcessed()
      .then(loadMermaid('default'))
      .catch(console.error)
    })
  }
  window.initMermaid = init
})(window);

こちら元となるコードは下記を参考にしました。

Reinitialize with new theme #1945

header.htmlのテーマ切り替え時の処理を修正

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
function switchTheme(theme) {
  switch (theme) {
    case 'light':
{{ if or .Params.mermaid .Site.Params.mermaid }}
      document.body.dispatchEvent(new CustomEvent('light-theme-set'));
{{ end }}
      document.body.classList.remove('dark');
      break;
    case 'dark':
{{ if or .Params.mermaid .Site.Params.mermaid }}
      document.body.dispatchEvent(new CustomEvent('dark-theme-set'));
{{ end }}
      document.body.classList.add('dark');
      break;
    // auto
    default:
      if (window.matchMedia('(prefers-color-scheme: dark)').matches) {
{{ if or .Params.mermaid .Site.Params.mermaid }}
        document.body.dispatchEvent(new CustomEvent('dark-theme-set'));
{{ end }}
        document.body.classList.add('dark');
      }
  }
}

layouts/shortcodes/mermaid.htmlを作成

1
2
3
<div class="mermaid" align="{{ if .Get "align" }}{{ .Get "align" }}{{ else }}center{{ end }}">
  {{ safeHTML .Inner }}
</div>

以上でmermaid.jsを使える準備が整いました。

mermaid.jsを使ってみる

記事の定義に下記を追加

1
marmaid: true

記事の本文に下記を追加

フローチャート

1
2
3
4
5
6
{{<mermaid align="center">}}
graph TD
    A[開始] -->|条件1| B(条件2)
    B --> C{条件3}
    C -->|条件4| D[終了]
{{</mermaid>}}

出力結果

graph TD A[開始] -->|条件1| B(条件2) B --> C{条件3} C -->|条件4| D[終了]

ガントチャート

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{{<mermaid align="center">}}
gantt
    section Project
    要件定義 :done,      a, 2024-05-25, 5d
    基本設計 :done,      b, after a,    5d
    詳細設計 :done,      c, after b,    5d
    製造    :active,    d, after c,    10d
    単体試験 :crit,      e, after d,    5d
    結合試験 :           f, after e,    5d
    総合試験 :           g, after f,    5d
    リリース :milestone, h, after g,    1d
{{</mermaid>}}

出力結果

gantt section Project 要件定義 :done, a, 2024-05-25, 5d 基本設計 :done, b, after a, 5d 詳細設計 :done, c, after b, 5d 製造 :active, d, after c, 10d 単体試験 :crit, e, after d, 5d 結合試験 : f, after e, 5d 総合試験 : g, after f, 5d リリース :milestone, h, after g, 1d

シーケンス図

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{{<mermaid align="center">}}
sequenceDiagram
    participant user
    participant view
    participant controller
    participant model
    participant database
    user->>view: ID/PW入力
    view->>controller: 認証リクエスト
    controller->>model: 認証リクエスト
    model->>database: 認証リクエスト
    database-->>model: 認証結果返却
    model-->>controller: 認証結果返却
    controller-->>view: 認証結果返却
    view-->>user: 認証結果表示
{{</mermaid>}}

出力結果

sequenceDiagram participant user participant view participant controller participant model participant database user->>view: ID/PW入力 view->>controller: ajax問い合わせ controller->>model: 認証リクエスト model->>database: SQL発行 database-->>model: SQL結果返却 model-->>controller: 認証リクエスト結果返却 controller-->>view: ajax問い合わせ結果返却 view-->>user: 認証結果表示

以上です。