Skip to content

Add support for GFM Alerts (admonition blocks) via commonmark-ext-gfm-alerts #219

@omatheusmesmo

Description

@omatheusmesmo

Context

commonmark/commonmark-java#420 has been merged and released as part of commonmark-java 0.28.0, adding a new commonmark-ext-gfm-alerts extension that supports GitHub Flavored Markdown alert blocks (also known as admonition blocks):

Note

This is a note.

Warning

This is a warning.

Supported types out of the box: NOTE, TIP, IMPORTANT, WARNING, CAUTION.

This feature is requested by quarkiverse/quarkus-roq#406 and will be consumed by Roq once available here.

Goal

  • Bump commonmark.version from 0.27.0 to 0.28.0 in the root pom.xml
  • Add commonmark-ext-gfm-alerts as a dependency in markdown/runtime/pom.xml
  • Create an AlertsConfiguration class (following the existing pattern of TablesConfiguration, AutolinkConfiguration, etc.) to register AlertsExtension as a CDI @DefaultBean
  • Add integration tests covering the 5 standard alert types

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions