Skip to content
OwnDocs
Feature

GitHub-style alerts

Callout blocks that pull attention to notes, tips, warnings, and danger notices, written with the same syntax GitHub Markdown already uses.

  • Alerts are callout blocks that draw reader attention to important information — notes, tips, warnings, and danger notices.
  • The syntax matches GitHub’s alert blocks, so authors already familiar with GitHub Markdown can use them immediately.
  • Six alert types — note, tip, important, warning, caution, and danger — written as a blockquote starting with [!TYPE], such as > [!WARNING] Something that could cause issues if ignored.
  • Each type carries its own color, icon, and label, so the right level of urgency reads at a glance. A custom remark plugin does the processing.