Read in about 1.5 minutes

AstroにMarkdown記法でダイアグラムやチャート描画できるようにした

アイキャッチ
公開日: 2023-11-29 更新日: 2023-12-17

Contents

What is a Mermaid?

ふとした瞬間、不意にフローチャートやシーケンス図、クラス図が書きたくなるときってあるよね?(…え、ない?)

ということで、思い立ってダイアグラムやチャートの作成ができるツール=JSライブラリのMermaidを、このブログ記事を書いているMDXファイル内にMarkdown記法で書けるようにしたので、導入手順を振り返ってみたい。

Yes
No
start
true?
process
exception
end

フローチャート図の例

Markdown: チャート図の書き方

```mermaid
flowchart TB
    A([start]) --> B{true?}
    B --Yes--> C[process]
    B --No--> D[exception]
    C & D --> E([end])
``` 

Astro&MDXへの導入手順

以下のURLの「Quick start」を参考にmdx-mermaidをAstroに導入した。一部ドキュメント通りだとうまく動かなかった部分があったので、その詳細については追記する。

https://github.com/sjwall/mdx-mermaid

後日更新。

Animal example
Animal
+int age
+String gender
+isMammal()
+mate()
Duck
+String beakColor
+swim()
+quack()
Fish
-int sizeInFeet
-canEat()
Zebra
+bool is_wild
+run()
From Duck till Zebra
can fly
can swim
can dive
can help in debugging
Animal example
Pets adopted by volunteers79%17%3%Pets adopted by volunteersDogsCatsRats
Category: Coding-IT
Tag:
#mdx
#mermaid
Author: Cloudy knot
< 前の記事
心身一如。マイペースに適度な運動習慣を持つことの効用
すべてのカテゴリー すべてのタグ
« ブログ記事一覧へ