Using Custom Panels in Markdown

Using Custom Panels in Markdown

This guide shows you how to use custom panels in your Markdown content to highlight important information, warnings, notes, and more.

Available Panel Types

This blog supports several types of panels that you can use in your Markdown content:

Info Panel

Use the Info Panel to provide additional information or context.

Information

This is an information panel. Use it to provide additional context or details about a topic.

<InfoPanel title="Information">
This is an information panel. Use it to provide additional context or details about a topic.
</InfoPanel>

Warning Panel

Use the Warning Panel to highlight potential issues or things to be careful about.

Be Careful

This is a warning panel. Use it to alert readers about potential issues or things to be careful about.

<WarningPanel title="Be Careful">
This is a warning panel. Use it to alert readers about potential issues or things to be careful about.
</WarningPanel>

Danger Panel

Use the Danger Panel for critical warnings or serious issues.

Critical Warning

This is a danger panel. Use it for critical warnings or serious issues that require immediate attention.

<DangerPanel title="Critical Warning">
This is a danger panel. Use it for critical warnings or serious issues that require immediate attention.
</DangerPanel>

Success Panel

Use the Success Panel to highlight positive outcomes or best practices.

Best Practice

This is a success panel. Use it to highlight positive outcomes, best practices, or successful approaches.

<SuccessPanel title="Best Practice">
This is a success panel. Use it to highlight positive outcomes, best practices, or successful approaches.
</SuccessPanel>

Note Panel

Use the Note Panel for side notes or additional thoughts.

Side Note

This is a note panel. Use it for side notes, additional thoughts, or supplementary information.

<NotePanel title="Side Note">
This is a note panel. Use it for side notes, additional thoughts, or supplementary information.
</NotePanel>

Using Panels Without Titles

You can also use panels without titles if you prefer:

This information panel doesn't have a title.

<InfoPanel>
This information panel doesn't have a title.
</InfoPanel>

Using the Generic Panel Component

If you want more control, you can use the generic Panel component and specify the type:

Custom Panel

This is a custom panel using the generic Panel component.

<Panel type="info" title="Custom Panel">
This is a custom panel using the generic Panel component.
</Panel>

Panels with Markdown Content

Panels can contain Markdown content, including:

Rich Content

  • Bold text
  • Italic text
  • Links
  • Lists
    • Nested items
    • More nested items
  • And more!
<InfoPanel title="Rich Content">
- **Bold text**
- *Italic text*
- [Links](https://example.com)
- Lists
  - Nested items
  - More nested items
- And more!
</InfoPanel>

Conclusion

Using panels in your Markdown content can help highlight important information and make your content more engaging and easier to scan. Try incorporating them in your next blog post!


© 2023 - 2026