2021-07-04-diagrams.md

layout	title	date	tags	description
post	a post with diagrams	2021-07-04 10:39:00 -0700	formatting diagrams	an example of a blog post with diagrams

This theme supports generating various diagrams from a text description using jekyll-diagrams{:target="_blank"} plugin. Below, we generate a few examples of such diagrams using languages such as mermaid{:target="_blank"}, plantuml{:target="_blank"}, vega-lite{:target="_blank"}, etc.

Note: different diagram-generation packages require external dependencies to be installed on your machine. Also, be mindful of that because of diagram generation the fist time you build your Jekyll website after adding new diagrams will be SLOW. For any other details, please refer to jekyll-diagrams{:target="_blank"} README.

Mermaid

Install mermaid using node.js package manager npm by running the following command:

npm install -g mermaid.cli

The diagram below was generated by the following code:

{% raw %}

{% mermaid %}
sequenceDiagram
    participant John
    participant Alice
    Alice->>John: Hello John, how are you?
    John-->>Alice: Great!
{% endmermaid %}

{% endraw %}

{% mermaid %} sequenceDiagram participant John participant Alice Alice->>John: Hello John, how are you? John-->>Alice: Great! {% endmermaid %}