Skip to content

Commit e2e2755

Browse files
committed
README: Add section about alerts
1 parent 471e639 commit e2e2755

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -333,6 +333,19 @@ Enables tables using pipes as in [GitHub Flavored Markdown][gfm-tables].
333333

334334
Use class `TablesExtension` in artifact `commonmark-ext-gfm-tables`.
335335

336+
### Alerts
337+
338+
Adds support for GitHub-style alerts (also known as callouts or admonitions) as described [here](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts), e.g.:
339+
340+
```
341+
> [!NOTE]
342+
> The text of the note.
343+
```
344+
345+
As types you can use NOTE, TIP, IMPORTANT, WARNING, CAUTION; or configure the extension to add additional ones.
346+
347+
Use class `AlertsExtension` in artifact `commonmark-ext-gfm-alerts`.
348+
336349
### Footnotes
337350

338351
Enables footnotes like in [GitHub](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#footnotes)

0 commit comments

Comments
 (0)