Merge pull request #423 from commonmark/alerts-followup

Alerts extension followups

Author: robinst

README.md

@@ -333,6 +333,19 @@ Enables tables using pipes as in [GitHub Flavored Markdown][gfm-tables].
 
 Use class `TablesExtension` in artifact `commonmark-ext-gfm-tables`.
 
+### Alerts
+
+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.:
+
+```
+> [!NOTE]
+> The text of the note.
+```
+
+As types you can use NOTE, TIP, IMPORTANT, WARNING, CAUTION; or configure the extension to add additional ones.
+
+Use class `AlertsExtension` in artifact `commonmark-ext-gfm-alerts`.
+
 ### Footnotes
 
 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)

commonmark-integration-test/pom.xml

@@ -28,6 +28,10 @@
             <groupId>org.commonmark</groupId>
             <artifactId>commonmark-ext-ins</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.commonmark</groupId>
+            <artifactId>commonmark-ext-gfm-alerts</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.commonmark</groupId>
             <artifactId>commonmark-ext-gfm-strikethrough</artifactId>

commonmark-integration-test/src/test/java/org/commonmark/integration/Extensions.java

@@ -4,6 +4,7 @@
 import org.commonmark.ext.autolink.AutolinkExtension;
 import org.commonmark.ext.footnotes.FootnotesExtension;
 import org.commonmark.ext.front.matter.YamlFrontMatterExtension;
+import org.commonmark.ext.gfm.alerts.AlertsExtension;
 import org.commonmark.ext.gfm.strikethrough.StrikethroughExtension;
 import org.commonmark.ext.gfm.tables.TablesExtension;
 import org.commonmark.ext.image.attributes.ImageAttributesExtension;
@@ -19,6 +20,7 @@ public class Extensions {
             FootnotesExtension.create(),
             ImageAttributesExtension.create(),
             InsExtension.create(),
+            AlertsExtension.create(),
             StrikethroughExtension.create(),
             TablesExtension.create(),
             TaskListItemsExtension.create(),

pom.xml

@@ -155,6 +155,11 @@
                 <artifactId>commonmark-ext-ins</artifactId>
                 <version>0.27.2-SNAPSHOT</version>
             </dependency>
+            <dependency>
+                <groupId>org.commonmark</groupId>
+                <artifactId>commonmark-ext-gfm-alerts</artifactId>
+                <version>0.27.2-SNAPSHOT</version>
+            </dependency>
             <dependency>
                 <groupId>org.commonmark</groupId>
                 <artifactId>commonmark-ext-gfm-strikethrough</artifactId>