#23 Enhancement: Warning/note/info blocks

Open
opened 1 year ago by ialbert · 1 comments
ialbert commented 1 year ago

A useful block type for documentation would be callout blocks for different kinds of info, including warnings, additional information, special notes, maybe others. No direct HTML equivalent except perhaps some document structure markers. Typically rendered as a bordered box with a large icon in the left margin, like :information_source: or :warning:.

Syntax could look something like:

(i) Info box

(!) Warning box
A useful block type for documentation would be callout blocks for different kinds of info, including warnings, additional information, special notes, maybe others. No direct HTML equivalent except perhaps some document structure markers. Typically rendered as a bordered box with a large icon in the left margin, like :information_source: or :warning:. Syntax could look something like: ``` (i) Info box (!) Warning box ```
ialbert commented 2 months ago
Owner
See Github https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts
Sign in to join this conversation.
No Label
No Milestone
No Assignees
1 Participants
Due Date

No due date set.

Dependencies

This issue currently doesn't have any dependencies.

Loading…
Cancel
Save
There is no content yet.