Skip to content

Block Component ​

Block gives notes, findings, examples, and warnings a consistent visual hierarchy.

Basic Usage ​

markdown
<Block type="info" title="Important Note">

Add the note here.

</Block>

The Markdown directive is equivalent:

markdown
:::block{type="info" title="Important Note"}
Add the note here.
:::

Available Types ​

TypeColorUse Case
defaultTheme primaryGeneral information
infoCyanInformational content
successGreenPositive results
warningYellowCautions
dangerRedCritical warnings
examplePurpleExamples
alertPinkAlerts

Examples ​

Information Block ​

markdown
:::block{type="info" title="Research Finding"}
Our study shows a significant improvement in accuracy.
:::

Warning Block ​

markdown
:::block{type="warning" title="Limitation"}
This method requires large amounts of training data.
:::

Example Block ​

markdown
:::block{type="example" title="Case Study"}
Consider the function $f(x) = x^2$...
:::

Props ​

PropTypeDefaultDescription
typestring'default'Block style type
titlestring-Optional title for the block
compactbooleanfalseReduces the outer margin and inner padding