Skip to content

Feature Request: Support Alerts/Callouts/Admonitions? #300

Description

@theory

[Apologies if this is not the place to submit request/ideas/etc. Happy to redirect elsewhere if preferred.]

GFM (and other implementations, too) supports alerts, e.g.,

> [!NOTE]
> Useful information that users should know, even when skimming content.

Which renders as (some newlines added to improve legibility):

<div class="markdown-alert markdown-alert-note" dir="auto">
  <p class="markdown-alert-title" dir="auto">
    <svg class="octicon octicon-info mr-2" viewBox="0 0 16 16" version="1.1" width="16" height="16" aria-hidden="true"><path d="M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z"></path></svg>
    Note
  </p>
  <p dir="auto">Useful information that users should know, even when skimming content.</p>
</div>

Which seems like overkill, frankly. Anyway, would be nice to support this syntax, perhaps without the SVG, something like:

<div class="markdown-alert markdown-alert-note" dir="auto">
  <p class="markdown-alert-title" dir="auto">Note</p>
  <p dir="auto">Useful information that users should know, even when skimming content.</p>
</div>

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions