In tech writing, an alert is used to highlight a bit of information. For example, here is an alert about the word alert:
An alert is usually one of the following five types.
| Alert Type | Meaning1 |
|---|---|
| note | Useful information that users should know, even when skimming content |
| tip | Helpful advice for doing things better or more easily |
| important | Key information users need to know to achieve their goal |
| warning | Urgent info that needs immediate user attention to avoid problems |
| caution | Advice about risks or negative outcomes of certain actions |
Before I switched from AsciiDoc to Markdown, I didn’t think much about styling Infinite Ink’s alerts because I used AsciiDoc alerts with Asciidoctor’s default styles. Here is what AsciiDoc alerts looks like on InfiniteĀ Ink:
ā¹ | An AsciiDoc āNoteā is rendered like this on InfiniteĀ Ink. |
š” | An AsciiDoc āTipā is rendered like this on InfiniteĀ Ink. |
ā¼ | An AsciiDoc āImportantā is rendered like this on InfiniteĀ Ink. |
ā | An AsciiDoc āWarningā is rendered like this on InfiniteĀ Ink. |
š§ | An AsciiDoc āCautionā is rendered like this on InfiniteĀ Ink. |
In Markdown, there is not a standard way to
create and style alerts,
but there has been a lot of discussion about this.
For example,
see
the following
talk.commonmark.org
discussion
that took place from
Ā ā ļø GitHub is beta testing their own Admonition syntax. We should weigh in
After a lot of discussion, GitHub is now styling a Markdown note alert like this:
Because Infinite Ink does not use GFM2 and because I don’t like the syntax or style of GFM alerts, I’m experimenting with the design of InfiniteĀ Ink’s alerts. They currently look like this:
The text of these alert meanings are from GitHub’s Markdown docs, which have a creative commons license.š ↩︎
Instead of GitHub-Flavored Markdown (GFM), Infinite Ink uses Goldmark-Flavored and Pandoc-Flavored Markdown. ↩︎
@nm@mathstodon.xyz
or
#InfiniteInk
in it.
Share this page on Mastodon.