Callout

think of a callout as a tiny, attention seeking spotlight for your most important or interesting content it's like a digital sticky note that screams, "hey, look at me!" it's a versatile block that can be used to highlight tips, warnings, best practices, or just about anything you want to emphasize why to use callouts? highlight key information is there something super important your users need to know? a callout is your megaphone provide helpful tips want to be the documentation hero? drop some helpful tips in callouts warn about potential issues prevent user tears by using callouts for warnings add a touch of personality callouts can be your secret weapon for injecting some personality into your docs 😎 pro tip use callouts sparingly too many and they lose their impact it's like shouting at someone it works for a while, but then it just gets annoying how to use the callout block? type / to open archbee block menu search for callout block and click to insert insert choose the callout style ℹ️ info — for general information, tips, or quick facts ✅ success — to celebrate accomplishments, highlight positive outcomes, or simply spread good vibes ⚠️ ⚠️ warning — to alert users to potential issues, cautionary notes, or important considerations 🛑 danger — for critical alerts, urgent messages, or situations that require immediate attention feel free to add your content you can style the content however you like using the wysiwyg menu or even insert other blocks, like headings docid\ ch1eclxgmlpa xazawy6u expandable headings docid\ ajpn6hemcswfb9rr4hdhz lists docid\ d02 vq5gnbt sueqotq3g button docid\ jdaxu7ibxba1jw3khorop horizontal divider docid\ yuthnhc9mnprzrtwxpb4l file docid\ t1ky085lzcmkkp3h9eba image docid\ mfibzf9k ya8z3ldzq37v video docid\ b2ip7djzj3ghcrxc42ril markdown want to add callouts to your documentation directly through markdown? we've got you covered you! archbee supports a specific markdown syntax with triple colons ( ) with this method, you simply type hint followed by an optional style attribute to define the callout type (info, warning, success or danger) use the following markdown to generate a callout block \## hints \ hint{style="info"} we would love you to contribute to `@octokit/rest`, pull requests are very welcome! please see contributing md for more information \ \ hint{style="warning"} we would love you to contribute to `@octokit/rest`, pull requests are very welcome! please see contributing md for more information \ \ hint{style="success"} we would love you to contribute to `@octokit/rest`, pull requests are very welcome! please see contributing md for more information \ \ hint{style="danger"} we would love you to contribute to `@octokit/rest`, pull requests are very welcome! please see contributing md for more information \ we would love you to contribute to @octokit/rest , pull requests are very welcome! please see contributing md for more information alternatively, use this flavor of markdown to generate a callout block {% hint style="info" %} some hint {% endhint %} check the use markdown shortcuts docid 9aacrqjmq9jnyvzsgnofs page to see more markdown shortcuts for other blocks examples here are some examples to show you the callout block ℹ️ info ℹ️ did you know? archbee is so good, it'll make you question your life choices like, why didn't you start using it sooner? ✅ success 🎉 you did it! you've mastered the art of callouts now go forth and create amazing documentation that will blow your competitors out of the water ⚠️ ⚠️ warning 🚧 🚧 heads up! using too many callouts can be distracting use them wisely, or your readers might start to ignore them altogether 🛑 danger 🚨 🚨 uh oh! if you're seeing this, something has gone terribly wrong 🫣 probably not with archbee though, we're perfect 💅✨ blame the coffee ☕️ find other blocks discover new ways and blocks to create stunning and functional documentation pages editor blocks docid 6b0vtqtvunmp93e szq2p need help? ⬇️ use the blue chat bubble from bottom right corner or try ai chat (from search box) for quick answers your opinion matters use the below feedback form, anonymously or ask a question in q\&a section and our team or ai will give you a solution