Merge pull request #430 from rdestefa/issue-429-custom-alert-titles

Add Support for Custom Alert Titles

Author: robinst

CHANGELOG.md

@@ -8,15 +8,24 @@ with the exception that 0.x versions can break between minor versions.
 
 ## [Unreleased]
 ### Added
-- Allow customizing HTML attributes for alert title `<p>` tag via `AttributeProvider`
 - Support rendering GFM task list items to Markdown
 - Support rendering YAML front matter to Markdown
+- Alerts
+  - Allow customizing HTML attributes for alert title `<p>` tag via `AttributeProvider`
+  - New configuration for `AlertsExtension` to allow authors to provide custom
+    titles per alert. See the
+    [custom titles section of the alerts README](./commonmark-ext-gfm-alerts/README.md#custom-alert-titles)
+    for more information.
+  - New configuration for `AlertsExtension` to allow alerts to be nested within
+    other blocks (including other alerts). See
+    [this section of the alerts README](./commonmark-ext-gfm-alerts/README.md#nesting-alerts)
+    for more information.
 
 ## [0.28.0] - 2026-03-31
 ### Added
 - New extension for alerts (aka callouts/admonitions)
   - Syntax:
-    ```
+    ```markdown
     > [!NOTE]
     > The text of the note.
     ```
@@ -104,9 +113,9 @@ with the exception that 0.x versions can break between minor versions.
 ### Added
 - New extension for footnotes!
   - Syntax:
-    ```
+    ```markdown
     Main text[^1]
-    
+
     [^1]: Additional text in a footnote
     ```
   - Inline footnotes like `^[inline footnote]` are also supported when enabled
@@ -271,7 +280,7 @@ with the exception that 0.x versions can break between minor versions.
   - Use class `ImageAttributesExtension` in artifact `commonmark-ext-image-attributes`
 - Extension for task lists (GitHub-style), thanks @dohertyfjatl
   - Syntax:
-    ```
+    ```markdown
     - [x] task #1
     - [ ] task #2
     ```

README.md

@@ -339,21 +339,22 @@ Use class `TablesExtension` in artifact `commonmark-ext-gfm-tables`.
 
 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.:
 
-```
+```markdown
 > [!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`.
+Use class `AlertsExtension` in artifact `commonmark-ext-gfm-alerts`. See the
+[`AlertsExtension` README](./commonmark-ext-gfm-alerts/README.md) for more information.
 
 ### 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)
 or [Pandoc](https://pandoc.org/MANUAL.html#footnotes):
 
-```
+```markdown
 Main text[^1]
 
 [^1]: Additional text in a footnote
@@ -370,7 +371,7 @@ is based on the text of the heading.
 
 `# Heading` will be rendered as:
 
-```
+```html
 <h1 id="heading">Heading</h1>
 ```
 
@@ -391,7 +392,7 @@ Use class `InsExtension` in artifact `commonmark-ext-ins`.
 
 Adds support for metadata through a YAML front matter block. This extension only supports a subset of YAML syntax. Here's an example of what's supported:
 
-```
+```markdown
 ---
 key: value
 list:
@@ -414,11 +415,11 @@ Adds support for specifying attributes (specifically height and width) for image
 
 The attribute elements are given as `key=value` pairs inside curly braces `{ }` after the image node to which they apply,
 for example:
-```
+```markdown
 ![text](/url.png){width=640 height=480}
 ```
 will be rendered as:
-```
+```html
 <img src="/url.png" alt="text" width="640" height="480" />
 ```
 
@@ -436,12 +437,12 @@ whitespace character or the letter `x` in lowercase or uppercase, then a right b
 whitespace before any other content.
 
 For example:
-```
+```markdown
 - [ ] task #1
 - [x] task #2
 ```
 will be rendered as:
-```
+```html
 <ul>
 <li><input type="checkbox" disabled=""> task #1</li>
 <li><input type="checkbox" disabled="" checked=""> task #2</li>

commonmark-ext-gfm-alerts/README.md

@@ -6,7 +6,7 @@ Enables highlighting important information using blockquote syntax with five sta
 
 ## Usage
 
-#### Markdown Syntax
+### Markdown Syntax
 
 ```markdown
 > [!NOTE]
@@ -16,15 +16,15 @@ Enables highlighting important information using blockquote syntax with five sta
 > Critical information
 ```
 
-#### Standard GFM Types
+### Standard GFM Types
 
 ```java
 var extension = AlertsExtension.create();
 var parser = Parser.builder().extensions(List.of(extension)).build();
 var renderer = HtmlRenderer.builder().extensions(List.of(extension)).build();
 ```
 
-#### Custom Alert Types
+### Custom Alert Types
 
 Add custom types beyond the five standard GFM types:
 
@@ -36,7 +36,45 @@ var extension = AlertsExtension.builder()
 
 Custom types must be UPPERCASE. Standard type titles can also be overridden for localization.
 
-#### Styling
+### Custom Alert Titles
+
+Allow authors to provide custom titles per alert by adding text after the alert
+marker on the same line:
+
+```java
+var extension = AlertsExtension.builder().allowCustomTitles(true).build();
+```
+
+```markdown
+> [!NOTE] Keep in mind <!-- Overrides default title of "Note" -->
+> Useful information
+
+> [!WARNING] Be **very** careful <!-- Inline formatting is supported -->
+> Critical information
+```
+
+### Nesting Alerts
+
+By default, alerts cannot be nested within other blocks. Alerts within other
+blocks are parsed as regular block quotes.
+
+```markdown
+<!-- Allowed -->
+> [!NOTE]
+> Useful information
+
+<!-- Not allowed -->
+- > [!NOTE]
+  > Useful information
+```
+
+This behavior can be changed to allow nested alerts:
+
+```java
+var extension = AlertsExtension.builder().allowNestedAlerts(true).build();
+```
+
+### Styling
 
 Alerts render as `<div>` elements with CSS classes:
 
@@ -51,9 +89,9 @@ Basic CSS example:
 
 ```css
 .markdown-alert {
-    padding: 0.5rem 1rem;
-    margin-bottom: 1rem;
-    border-left: 4px solid;
+  padding: 0.5rem 1rem;
+  margin-bottom: 1rem;
+  border-left: 4px solid;
 }
 
 .markdown-alert-note { border-color: #0969da; background-color: #ddf4ff; }

commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/Alert.java

@@ -4,6 +4,8 @@
 
 /**
  * Alert block for highlighting important information using {@code [!TYPE]} syntax.
+ *
+ * @see AlertTitle
  */
 public class Alert extends CustomBlock {
 

commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/AlertTitle.java

@@ -0,0 +1,24 @@
+package org.commonmark.ext.gfm.alerts;
+
+import org.commonmark.node.CustomNode;
+
+/**
+ * Inline content container for the optional custom title of an {@link Alert}.
+ *
+ * <p>
+ * When present, an {@code AlertTitle} is always the first child of an {@link Alert}.
+ * Its own children are the parsed inline nodes of the title (i.e., the text after
+ * the {@code [!TYPE]} marker on the same line). For example, in
+ *
+ * <pre>{@code
+ * > [!NOTE] Custom _title_
+ * > Body text
+ * }</pre>
+ *
+ * the {@code AlertTitle} contains a {@code Text} node ({@code "Custom "}) followed
+ * by an {@code Emphasis} node wrapping {@code "title"}.
+ *
+ * @see AlertsExtension.Builder#allowCustomTitles(boolean)
+ */
+public class AlertTitle extends CustomNode {
+}

commonmark-ext-gfm-alerts/src/main/java/org/commonmark/ext/gfm/alerts/AlertsExtension.java

@@ -1,7 +1,7 @@
 package org.commonmark.ext.gfm.alerts;
 
 import org.commonmark.Extension;
-import org.commonmark.ext.gfm.alerts.internal.AlertPostProcessor;
+import org.commonmark.ext.gfm.alerts.internal.AlertBlockParser;
 import org.commonmark.ext.gfm.alerts.internal.AlertHtmlNodeRenderer;
 import org.commonmark.ext.gfm.alerts.internal.AlertMarkdownNodeRenderer;
 import org.commonmark.parser.Parser;
@@ -21,19 +21,44 @@
  * Extension for GFM alerts using {@code [!TYPE]} syntax (GitHub Flavored Markdown).
  * <p>
  * Create with {@link #create()} or {@link #builder()} and configure on builders
- * ({@link org.commonmark.parser.Parser.Builder#extensions(Iterable)},
- * {@link HtmlRenderer.Builder#extensions(Iterable)}).
- * Parsed alerts become {@link Alert} blocks.
+ * ({@link Parser.Builder#extensions(Iterable)}, {@link HtmlRenderer.Builder#extensions(Iterable)}).
+ * Parsed alerts become {@link Alert} blocks. If custom alert titles are allowed
+ * via {@link Builder#allowCustomTitles(boolean)}, the inline formatting of those
+ * titles will be parsed into {@link AlertTitle} nodes.
+ *
+ * The {@link #create() default configuration} of this extension will match GFM
+ * exactly, with the following exceptions:
+ *
+ * - Alert markers take precedence over <a href="https://spec.commonmark.org/current/#shortcut-reference-link">shortcut reference links</a>.
+ * - Alerts with no content are allowed. Example:
+ *
+ *   <pre>{@code
+ *   <!-- Valid -->
+ *   > [!NOTE]
+ *
+ *   <!-- Also valid if custom titles are allowed -->
+ *   > [!NOTE] Custom title
+ *   }</pre>
+ * - Lazy continuation is not allowed between the marker and the body text. Example:
+ *
+ *   <pre>{@code
+ *   > [!NOTE]
+ *   Lazy body text will be parsed as a new paragraph
+ *   }</pre>
  */
 public class AlertsExtension implements Parser.ParserExtension, HtmlRenderer.HtmlRendererExtension,
         MarkdownRenderer.MarkdownRendererExtension {
 
     static final Set<String> STANDARD_TYPES = Set.of("NOTE", "TIP", "IMPORTANT", "WARNING", "CAUTION");
 
     private final Map<String, String> customTypes;
+    private final boolean customTitlesAllowed;
+    private final boolean nestedAlertsAllowed;
 
     private AlertsExtension(Builder builder) {
         this.customTypes = new HashMap<>(builder.customTypes);
+        this.customTitlesAllowed = builder.customTitlesAllowed;
+        this.nestedAlertsAllowed = builder.nestedAlertsAllowed;
     }
 
     public static Extension create() {
@@ -48,7 +73,8 @@ public static Builder builder() {
     public void extend(Parser.Builder parserBuilder) {
         var allowedTypes = new HashSet<>(STANDARD_TYPES);
         allowedTypes.addAll(customTypes.keySet());
-        parserBuilder.postProcessor(new AlertPostProcessor(allowedTypes));
+        parserBuilder.customBlockParserFactory(
+            new AlertBlockParser.Factory(allowedTypes, customTitlesAllowed, nestedAlertsAllowed));
     }
 
     @Override
@@ -76,6 +102,8 @@ public Set<Character> getSpecialCharacters() {
      */
     public static class Builder {
         private final Map<String, String> customTypes = new HashMap<>();
+        private boolean customTitlesAllowed = false;
+        private boolean nestedAlertsAllowed = false;
 
         /**
          * Adds a custom alert type with a display title.
@@ -101,6 +129,34 @@ public Builder addCustomType(String type, String title) {
             return this;
         }
 
+        /**
+         * Allows or disallows custom titles on alerts. Inline formatting is supported
+         * within these titles.
+         * @param allow Whether to allow or disallow custom titles on alerts.
+         * @return {@code this}
+         * @see AlertTitle
+         */
+        public Builder allowCustomTitles(boolean allow) {
+            customTitlesAllowed = allow;
+            return this;
+        }
+
+        /**
+         * Allows or disallows parsing alerts within non-root blocks ({@code Document}).
+         * <p>
+         * When disallowed, if an alert appears within another block, it will be parsed as
+         * a regular {@code BlockQuote}.
+         * <p>
+         * Note that even when this is allowed, {@link Parser.Builder#maxOpenBlockParsers(int)}
+         * will be respected.
+         * @param allow Whether to allow or disallow parsing alerts within non-root blocks.
+         * @return {@code this}
+         */
+        public Builder allowNestedAlerts(boolean allow) {
+            nestedAlertsAllowed = allow;
+            return this;
+        }
+
         /**
          * @return a configured {@link Extension}
          */