分類
概要・利用パターン | 利益 or 被害 | マストかベターか | |
Note | 要約。これだけしっておけばOKな情報。 | 利益を増やす | マスト |
Tip | ベストプラクティス。 | 利益を増やす | ベター |
Important | 文中での補足となる重要な情報。 | どちらでもない | マスト |
Warning | 問題が発生しそうなシーンに対する情報 | 被害を減らす | マスト |
Caution | アクションに対する不利益やリスク | 被害を減らす | マスト |
GitHubより
== NOTE==
==
==コンテンツをざっと読むときでも、ユーザーが知っておくべき有用な情報です。
== TIP
==物事をより良く、より簡単に行うための役立つアドバイスです。
== IMPORTANT
==ユーザーが目標を達成するために知っておく必要のある重要な情報です。
== WARNING
==問題を回避するためにユーザーがすぐに注意を払う必要がある緊急情報です。
== CAUTION
==特定のアクションのリスクや否定的な結果についてアドバイスします。
> [!NOTE]
>
> コンテンツをざっと読むときでも、ユーザーが知っておくべき有用な情報です。
> [!TIP]
>
> 物事をより良く、より簡単に行うための役立つアドバイスです。
> [!IMPORTANT]
>
> ユーザーが目標を達成するために知っておく必要のある重要な情報です。
> [!WARNING]
>
> 問題を回避するためにユーザーがすぐに注意を払う必要がある緊急情報です。
> [!CAUTION]
>
> 特定のアクションのリスクや否定的な結果についてアドバイスします。