Callouts, or admonitions, are styled content blocks used in documentation and blogs to highlight important information such as tips, warnings, or notes. Their purpose is to improve readability by drawing attention to key details. Advantages include clearer communication, reduced risk of overlooked information, and a more structured, professional presentation.
Error Test
Helpful advice for doing things better or more easily.
GitHub Test
Useful information that users should know, even when skimming content.
Helpful advice for doing things better or more easily.
Key information users need to know to achieve their goal.
Urgent info that needs immediate user attention to avoid problems.
Advises about risks or negative outcomes of certain actions.
Callout Overview
Abstract: This paper discusses the advantages and challenges of microservice architecture.
Advises about risks or negative outcomes of certain actions.
Code snippet:
function fetchData() {
return axios.get("/api/data");
}
Conclusion: Based on the analysis above, we’ve decided to implement Docker containerization.
Danger! Critical security vulnerability detected in the system. Immediate action required.
Error: Unable to connect to database. Please check your connection settings.
Example:
def hello_world():
print("Hello, World!")
Experiment: Testing the impact of new caching strategies on system performance.
Goal: Reduce service response time by 30% by the end of this quarter.
Idea: Implement a machine learning-based code quality detection system.
Key information users need to know to achieve their goal.
System status: All services are operating normally. Current uptime: 99.99%.
Memo: Technical review meeting scheduled for next Tuesday at 2:00 PM.
Useful information that users should know, even when skimming content.
System notification: Your password will expire in 30 days.
Question: How can we optimize database query performance?
“Code is like humor. When you have to explain it, it’s bad.” - Cory House
Congratulations! Your code has been successfully deployed to production.
To-do list:
- Update documentation
- Deploy new version
Helpful advice for doing things better or more easily.
Urgent info that needs immediate user attention to avoid problems.
Customisation
Adding a custom title to a callout style
This is a summary using the TIP callout!
This is a summary using the IDEA callout!
Header Only Mode
It is possible to only show the header!
npm install to install all dependenciesCtrl + C to quickly terminate a running programFoldable Admonitions
Here are the details regarding API usage:
- Endpoint:
/api/v1/usersis used to fetch the user list. - Authentication: A valid
Bearertoken must be provided in the request header. - Rate Limiting: 100 requests are allowed per minute.
Click here to view the tips
Nested Admonitions
[!example] You can even use multiple layers of nesting.
Some of the callout styles available for use and examples of thier rendering
98cb3b2 (added style and overflow to codeblock render) [!NOTE] Useful information that users should know, even when skimming content.
Helpful advice for doing things better or more easily.
Key information users need to know to achieve their goal.
Urgent info that needs immediate user attention to avoid problems.
Advises about risks or negative outcomes of certain actions.
Radiation hazard
Do not approach or handle without protective gear.
This is a summary using the IDEA callout!
This is a summary using the MEMO callout!
Click here to view the tips
This is a closed tip
Click here to view the tips
This is the tip YAY
sample code here
Using custom short code and styling
This is a note.
This is a warning.
This is dangerous.