Пробуем mermaid.js

Что такое mermaid.js

mermaid.js — это библиотека JavaScript, которая позволяет писать текстовый синтаксис (синтаксис Mermaid) для графического отображения сложных диаграмм, таких как блок-схемы, графы и диаграммы Ганта. Она также используется в различных сервисах, таких как GitHub, Qiita и Notion. На этот раз мы попробуем включить использование mermaid.js в hugo.

Включение mermaid.js в hugo

Шаги следующие:

Добавьте следующее в 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 }}

※ mermaid.min.js загружается только если mermaid: true в условии if. Эта библиотека довольно большая, около 3 МБ.

Создайте 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: Показ результата аутентификации

На этом всё.

Что такое mermaid.js

Включение mermaid.js в hugo

Использование mermaid.js

Ссылки