Callouts
Notes, warnings and errors beside the text.
A callout sets a short note apart from the text around it. Its type sets the icon and the colour of the bar.
A plain note. Use it for a detail the reader can skip.
Warning
Use a warning for a step that can lose data or break a build.
Error
Use an error for something that does not work.
Success
Use a success note to show the expected result.
MDX
<Callout>A plain note.</Callout>
<Callout type="warn" title="Warning">
Use a warning for a step that can lose data or break a build.
</Callout>Types
type | Use |
|---|---|
info | The default. A side note |
warn | A risk, or a step that is easy to get wrong |
error | A known failure |
success | The result of a step |
idea | A tip |
The background of a callout is grey in every type. Only the bar and the icon take the status colour.
Edit on GitHub
Last updated on