初めに
Githubには以前から下記のように、Markdownで書かれた文章の見た目をちょっとだけリッチにする記法があります。
このような記法を使うことで、筆者が伝えたいことを分類し、強調することが出来ます。
視覚的に強調されるため、ユーザーは重要な情報を見逃すことは減り、操作ミスの削減につながるため、積極的に取り入れて使っていきましょう！
書き方
説明するより見てもらった方が早いので、パパっと紹介！
> [!NOTE]
> Useful information that users should know, even when skimming content.<br>
> コンテンツをざっと読むときでもユーザーが知っておくべき有用な情報。
> [!TIP]
> Helpful advice for doing things better or more easily.<br>
> 物事をより良く、より簡単に行うための役立つアドバイス。
> [!IMPORTANT]
> Key information users need to know to achieve their goal.<br>
> ユーザーが目標を達成するために知っておく必要のある重要な情報。
> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.<br>
> 問題を回避するためにユーザーがすぐに対応する必要がある緊急情報。
> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.<br>
> 特定の行動のリスクや否定的な結果についてアドバイスします。
ちょっとした小技
箇条書きやリスト、表と組み合わせて記述することも可能です！
書き方は下記の通り
> [!NOTE]
> 箇条書きも可能！
> - リンゴ
> - ほうれん草
> - 鮭
> [!TIP]
> リスト形式も可能だよ！
> 1. パイナップル
> 2. きゅうり
> 3. 鯖
> [!IMPORTANT]
> 表形式も可能じゃ！
> |No|列１|列２|
> | --- | --- | --- |
> |1|桃|アボカド|
> |2|トマト|ズッキーニ|
> |3|まぐろ|エビ|
最後に
色がつくと一気に見た目が華やかになるので、書いていて楽しくなりますよね。
筆者も読者も両方にメリットがあってwin-winなので、今後も使っていこうと思う次第じゃ。