GitHub仕様のアラート構文を追加しました

今回のリリース内容

GitHubで昨年末に正式に実装された、引用構文に基づいたアラート構文を追加しました。

2024-03-01.png (212.1 kB)

基本的な書き方とフォーマットの構文 - GitHub Docs
アラートは、重要な情報を強調する際に使用できるブロッククォート構文に基づいたMarkdown拡張です。 GitHub では、コンテンツの重要度を示す独特の色とアイコンが表示されます。

上記のGitHub のドキュメントにも記述がありますが、アラート構文を使いすぎると逆に記事が読みにくくなる場合がありますので、どうしても必要な場合のみに使うのがよいかと思います。

今回のリリースでは可能な限りGitHubのアラート構文の仕様を再現したつもりですが、もし挙動が違うという場合はご連絡ください。できるだけGitHubと同じ仕様に調整していきたいと思います

アラート構文のサンプル

> [!NOTE]
> 内容を斜め読みする場合でも、ユーザーが知っておくと便利な情報。

> [!TIP]
> 物事をより良く、より簡単に行うための有用なアドバイス。

> [!IMPORTANT]
> ユーザーが目的を達成するために知っておくべき重要な情報。

> [!WARNING]
> 問題を避けるために、ユーザーが直ちに注意を払う必要がある緊急情報。

> [!CAUTION]
> 特定の行動が引き起こすリスクや悪影響について警告する。

Note

内容を斜め読みする場合でも、ユーザーが知っておくと便利な情報。

Tip

物事をより良く、より簡単に行うための有用なアドバイス。

Important

ユーザーが目的を達成するために知っておくべき重要な情報。

Warning

問題を避けるために、ユーザーが直ちに注意を払う必要がある緊急情報。

Caution

特定の行動が引き起こすリスクや悪影響について警告する。

(\( ⁰⊖⁰)/) ヒトコト

Warning

花粉に注意

[ProTip] Webhookでdocs.esa.ioの更新通知を受け取ることができます

Enjoy "(\( ⁰⊖⁰)/)"
https://esa.io

END

  • Close