開発用のドキュメントでMarkdownがよく使われるようになっていますが、足りない機能が多いのも確かです。HTMLも埋め込んで使えますが、それではMarkdownを使っている意味がないと思ってしまうでしょう。 Markdownの中にドローイングを埋め込みたい時にはPikchrを使ってみるのを検討しましょう。

Pikchrの使い方

PikchrはMarkdownの中で使えるドロー用機能になります。例えば上がPikchr、下にその結果が表示されています。

こんな複雑な図も描けます。

システム開発時によく使われそうなコンポーネントです。

こういった図もよく使われますね。

ダークモード対応です。

PikchrはMarkdownをソースとして、Pikchrを指定している部分をSVGに置き換えます。その結果、HTMLとSVGが組み合わさったドキュメントが生成されます。C言語で作られているので、他のシステムに組み込んで使うのも可能でしょう。

PikchrはC言語製のオープンソース・ソフトウェア(Zero-Clause BSD)です。

Pikchr: Documentation