MarkdownのツールによるNote記法対応状況について調べてみた

はじめに

• マークダウンで書いてて、ツールによって書き方が違ったりするのに結構苦労する
• 特にノート記法は対応していなかったり書き方もバラバラだったりする
  • ノート記法: note や warning などをアイコンと一緒に強調表示するやつ
• なのでどのツールでどんな対応（書き方）かを調べてみました
• なお、あくまでもこの記事を投稿した時点で、自分が調べた中での結果です。
• 今後対応状況が変わる可能性がありますのでその点ご注意ください。

Qiita

info, warn, alertの三種類だけのようです。書き方は以下の通りです。

:::note info
これはインフォメーションです
:::

:::note warn
これはワーニングです
:::

:::note alert
これはアラートです
:::

GitHub

Note, Warningの二種類だけのようです。書き方は以下の通りです。

Note
これはノートです

Warning
これはワーニングです

その他

いくつかで有効な記法です

• VSCode(markdown preview enhanced)
• MkDocs(python製のmarkdownドキュメントツール)
  • materialテーマをインストールする必要あり

8種類存在し、書き方は以下の通りです。

!!! Note
    これはノートです。

!!! Tip
    これはヒントです。

!!! Warning
    これはワーニングです
    
!!! Danger
    これはデンジャーです。

!!! Success
    これは成功です。

!!! Failure
    これは失敗です。

!!! Bug
    これはバグです。

!!! summary
    これはサマリーです。

そもそもこんな機能ない

• 以下のものは使えないようです
  • VSCode(元からあるmarkdownのプレビュー機能)
  • はてなブログ

最後に

• それぞれでノート記法を調べました。
• 「このツールではどう書くんだっけ？」と言う時に参考にしていただければと思います