Admonition

#ドキュメント

https://gyazo.com/437940a933a60c89d67e2f05b947e960

https://gyazo.com/5e8d701ca62ee21145bc43ade3050f24

https://gyazo.com/396757e2016fdbc853e8b221a5e517c9

「call-outs」「callouts」とも

日本語では「注意書き」

文書において、Tipsや注意書きなどを記載する小さな箱を「Admonition」と呼ぶ

MarkdownやScrapbox等で標準でサポートされている記法ではない

ビューワ・エディタによってはプラグイン等によってサポートすることも

大体、Quote記法で代用してしまう

よく観測するAdmonitions

⚡ Danger

⚠ Warning

❗ Important

✅ Check

💡 Tip

ℹ Info

🔗 See Also

✏ Note

Scrapbox

ネイティブでは対応していないが、UserCSSを用いて実現可能

→ UserCSS: Admonitions

GitHub Markdown

GitHubのMarkdownでは、引用記法を拡張した独自記法で記述可能

https://github.com/orgs/community/discussions/16925

code:markdown

!NOTE

Highlights information that users should take into account, even when skimming.

!TIP

Optional information to help a user be more successful.

!IMPORTANT

Crucial information necessary for users to succeed.

!WARNING

Critical content demanding immediate user attention due to potential risks.

!CAUTION

Negative potential consequences of an action.

https://gyazo.com/8a730bf2acb98c44c9ab1e2450a34ccd

Docusaurusにおける記法

DocusaurusのドキュメントはMarkdownで記述するが、以下のような特殊記法が追加されている

中で通常のMarkdown記法も記述可能

https://docusaurus.io/docs/markdown-features/admonitions

code:md

:::note

This is a **note**.

:::

:::warning

This is a **warning**.

:::

https://gyazo.com/15cf1e5227953232d3431bdf795cc7de