hexo-filter-mermaid-diagrams

mermaid diagrams for hexo

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
hexo-filter-mermaid-diagrams
71141.0.55 years ago5 years agoMinified + gzip package size for hexo-filter-mermaid-diagrams in KB

Readme

hexo-filter-mermaid-diagrams
Generation of diagrams and flowcharts from text in a similar manner as markdown. Mermaid plugin is using mermaid.js fro hexo!

flowchart

graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;

Sequence diagram

sequenceDiagram
    participant Alice
    participant Bob
    Alice->>John: Hello John, how are you?
    loop Healthcheck
        John->>John: Fight against hypochondria
    end
    Note right of John: Rational thoughts <br/>prevail...
    John-->>Alice: Great!
    John->>Bob: How about you?
    Bob-->>John: Jolly good!

Gantt diagram

gantt
dateFormat  YYYY-MM-DD
title Adding GANTT diagram 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

Class diagram - ❗️ experimental

classDiagram
Class01 <|-- AveryLongClass : Cool
Class03 *-- Class04
Class05 o-- Class06
Class07 .. Class08
Class09 --> C2 : Where am i?
Class09 --* C3
Class09 --|> Class07
Class07 : equals()
Class07 : Object[] elementData
Class01 : size()
Class01 : int chimp
Class01 : int gorilla
Class08 <--> C2: Cool label

Git graph - ❗️ experimental

gitGraph:
options
{
    "nodeSpacing": 150,
    "nodeRadius": 10
}
end
commit
branch newbranch
checkout newbranch
commit
commit
checkout master
commit
commit
merge newbranch

Click here Mermaid to learn more official discriptions!

Step1 Install Package

$ yarn add hexo-filter-mermaid-diagrams

Step2 Edit Config

After installed, you should edit hexo config file: _config.yml:
# mermaid chart
mermaid: ## mermaid url https://github.com/knsv/mermaid
  enable: true  # default true
  version: "7.1.2" # default v7.1.2
  options:  # find more api options from https://github.com/knsv/mermaid/blob/master/src/mermaidAPI.js
    #startOnload: true  // default true

Step3 include mermaid.js in pug or ejs

After edited _config.yml, you shou edit your blog page component like after_footer.pug or after-footer.ejs.
Where is it?
Open your theme folder, you can see the layout folder, open it and then you could see it.
Okey! if your blog is used pug, you can copy the below codes in after_footer.pug:
if theme.mermaid.enable == true
  script(type='text/javascript', id='maid-script' mermaidoptioins=theme.mermaid.options src='https://unpkg.com/mermaid@'+ theme.mermaid.version + '/dist/mermaid.min.js' + '?v=' + theme.version)
  script.
    if (window.mermaid) {
      var options = JSON.parse(document.getElementById('maid-script').getAttribute('mermaidoptioins'));
      mermaid.initialize(options);
    }

or after-footer.ejs should copy below codes:
<% if (theme.mermaid.enable) { %>
  <script src='https://unpkg.com/mermaid@<%= theme.mermaid.version %>/dist/mermaid.min.js'></script>
  <script>
    if (window.mermaid) {
      mermaid.initialize({theme: 'forest'});
    }
  </script>
<% } %>

Fixed

  • className 'mermaid' can be showed mermaid diagrams everywhere
  • Keep dom right;
  • Article preview lists can show code, and post show diagrams;

Credits

Thanks to the Mermaid project!