Qiita の注意書き系は、公式チートシート上では :::note 系が基本です。
Qiita の note 記法
使える種類は主にこの3つです。Qiita公式の Markdown チートシートでは、info は省略可能、warn は警告、alert はより強い警告として説明されています。(Qiita)
:::note
インフォメーション
info は省略可能です。
::::::note インフォメーション info は省略可能です。 :::
:::note info
インフォメーション
::::::note info インフォメーション :::
:::note warn
警告
○○に注意してください。
::::::note warn 警告 ○○に注意してください。 :::
:::note alert
より強い警告
○○しないでください。
::::::note alert より強い警告 ○○しないでください。 :::
使い分け
| 記法 | 用途 |
|---|---|
:::note | 補足、メモ、参考情報 |
:::note info | :::note と同じ。明示したい場合 |
:::note warn | 注意、警告、破壊的でないリスク |
:::note alert | 強い警告、危険、破壊的操作、セキュリティ注意 |
実用例
:::note warn
このコマンドはローカルの未コミット変更を上書きする可能性があります。
実行前に `git status` を確認してください。
::::::note alert
本番データベースに対して直接実行しないでください。
データが復旧できなくなる可能性があります。
:::GitHub の Alert 記法とは別物
GitHub では次のような記法があります。
> [!WARNING]
> This is a warning.ただし、これは GitHub Flavored Markdown 側の Alert 記法で、Qiita の :::note warn とは別です。Qiita 向け記事なら、基本は :::note warn / :::note alert を使うのが安全です。
結論
Qiita で注意書きを入れるなら、通常はこれで十分です。
:::note warn
注意事項を書きます。
::::::note warn 注意事項を書きます。 :::
より強く止めたい内容ならこちらです。
:::note alert
絶対に本番環境で実行しないでください。
::::::note alert 絶対に本番環境で実行しないでください。 :::