はじめに
Suzukiです。今回はmarkdownについて書きます。
Markdown記法とは
Markdown記法とは軽量マークアップ言語の1つです。記法については以下の公式ドキュメントを参考にしてください。
参考:mermaid公式ドキュメント -> https://mermaid-js.github.io/mermaid/#/
図表を描くならmermaid
簡単な図を表すのに便利です。試しに書いてみると、 日本の地方別人口の円グラフ
```mermaid pie title 日本の地域別人口(万人)(平成 22 年) "関東" : 4175 "近畿" : 2250 "中部" : 2157 "九州" : 1467 "東北" : 942 "中国" : 758 "北海道" : 552 "四国" : 404 ```というような円グラフが描けます。
ライブエディタは以下にあります。
参考:Mermaid Live Editor -> https://mermaid-js.github.io/mermaid-live-editor/#/edit/eyJjb2RlIjoiZ3JhcGggVERcbiAgICBBW0NocmlzdG1hc10gLS0-fEdldCBtb25leXwgQihHbyBzaG9wcGluZylcbiAgICBCIC0tPiBDe0xldCBtZSB0aGlua31cbiAgICBDIC0tPnxPbmV8IERbTGFwdG9wXVxuICAgIEMgLS0-fFR3b3wgRVtpUGhvbmVdXG4gICAgQyAtLT58VGhyZWV8IEZbZmE6ZmEtY2FyIENhcl0iLCJtZXJtYWlkIjp7fSwidXBkYXRlRWRpdG9yIjpmYWxzZX0
参考:Mermaid Live Editor -> https://mermaid-js.github.io/mermaid-live-editor/#/edit/eyJjb2RlIjoiZ3JhcGggVERcbiAgICBBW0NocmlzdG1hc10gLS0-fEdldCBtb25leXwgQihHbyBzaG9wcGluZylcbiAgICBCIC0tPiBDe0xldCBtZSB0aGlua31cbiAgICBDIC0tPnxPbmV8IERbTGFwdG9wXVxuICAgIEMgLS0-fFR3b3wgRVtpUGhvbmVdXG4gICAgQyAtLT58VGhyZWV8IEZbZmE6ZmEtY2FyIENhcl0iLCJtZXJtYWlkIjp7fSwidXBkYXRlRWRpdG9yIjpmYWxzZX0
メリット
HTMLで書くより簡単に記述できます。またHTMLのタグも使用できるので便利です。
PDFに変換することで配布しやすくなります。
実際の使用法
markdownで文章を書いてmermaidで図を描きこみ、PDFに変換して配りやすくして使っています。最近では、業務の作業手順書をmarkdownで書きPDFに変換して関係部署に配布しました。
余談
実は今書いているのもmarkdownエディタを使って書いています(笑)右にプレビューを出しながら書くと、見栄えを確認しながら書けるので便利ですね。