Skip to content

Commit df9bc12

Browse files
committed
Add github markdown alert samples
with the idea that we'll cljdoc will render them sometime soon
1 parent eda3156 commit df9bc12

File tree

1 file changed

+66
-2
lines changed

1 file changed

+66
-2
lines changed

doc/tests/md-features.md

Lines changed: 66 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -189,8 +189,72 @@ GitHub flavored markdown supports emojis.
189189
190190
And here we are.
191191
192-
## Admonitions
193-
CommonMark does not support admonitions
192+
## Alerts
193+
GitHub Markdown has an alert extension which is conceptually equivalent to AsciiDoc admonitions.
194+
195+
From most serious to least:
196+
197+
> [!IMPORTANT]
198+
> Important things are said here.
199+
200+
> [!WARNING]
201+
> Warning to the wise.
202+
203+
> [!CAUTION]
204+
> Aren't you a caution?
205+
206+
> [!NOTE]
207+
> Note that this note is a note.
208+
209+
> [!TIP]
210+
> Tip the scales with a tip.
211+
212+
And how do alerts look with some code in them?
213+
214+
> [!IMPORTANT]
215+
> This alert has some `code` in it.
216+
>
217+
> ```clojure
218+
> (how
219+
> (does
220+
> (this "look?)))
221+
> ```
222+
223+
> [!WARNING]
224+
> This alert has some `code` in it.
225+
>
226+
> ```clojure
227+
> (how
228+
> (does
229+
> (this "look?)))
230+
> ```
231+
232+
> [!CAUTION]
233+
> This alert has some `code` in it.
234+
>
235+
> ```clojure
236+
> (how
237+
> (does
238+
> (this "look?)))
239+
> ```
240+
241+
> [!NOTE]
242+
> This alert has some `code` in it.
243+
>
244+
> ```clojure
245+
> (how
246+
> (does
247+
> (this "look?)))
248+
> ```
249+
250+
> [!TIP]
251+
> This alert has some `code` in it.
252+
>
253+
> ```clojure
254+
> (how
255+
> (does
256+
> (this "look?)))
257+
> ```
194258
195259
## Text Roles
196260

0 commit comments

Comments
 (0)