Skip to main content
OwnDocs

Alerts

1 min readStableBeginner

Alerts are callout blocks that draw attention to important information. OwnDocs supports six GitHub-style alert types, each with a distinct color and icon.

Quick Start

A single note.

ℹ️ NOTE Notes highlight information readers should notice while skimming.

Adding Options

Combine a tip and an important alert.

💡 TIP Tips provide optional information to help readers be more successful.

📝 IMPORTANT Important information readers need to know to achieve their goal.

Advanced

Use warning, caution, and danger for escalating risk, with multi-line content.

⚠️ WARNING Be careful when modifying environment variables.

Changing JWT_SECRET invalidates all existing sessions.

CAUTION Advises about risks or negative outcomes of certain actions.

🚨 DANGER Destructive or irreversible actions that could cause significant harm.

Options

[!TYPE]stringrequired

One of NOTE, TIP, IMPORTANT, WARNING, CAUTION, DANGER.

Was this page helpful?