Markdown

Install

Terminal

$ roq add plugin:markdown

Process .md and .markdown files using CommonMark Java.

Markdown plugin is already included in Quarkus Roq extension. No separate installation needed unless you removed it.

Every file with .md or .markdown extension will be processed.

Rendering is powered by Quarkus Qute Web Markdown, which bundles the following commonmark-java extensions, all enabled by default:

Extension	Property	Description
Tables	`quarkus.qute.web.markdown.plugin.tables.enabled`	GitHub Flavored Markdown tables
Autolink	`quarkus.qute.web.markdown.plugin.autolink.enabled`	Bare URLs and email addresses become links
Heading anchor	`quarkus.qute.web.markdown.plugin.heading-anchor.enabled`	Adds an `id` to every heading so it can be linked with `#my-title`
Alerts	`quarkus.qute.web.markdown.plugin.alerts.enabled`	GitHub Flavored Markdown alert blocks (`> [!NOTE]`, `> [!TIP]`, ...)

Set a property to false in application.properties to disable the corresponding extension:

quarkus.qute.web.markdown.plugin.autolink.enabled=false

Custom alert types can be registered with quarkus.qute.web.markdown.plugin.alerts.custom-types.<TYPE>=<Title> (the type must be uppercase):

quarkus.qute.web.markdown.plugin.alerts.custom-types.INFO=Information
quarkus.qute.web.markdown.plugin.alerts.custom-types.BUG=Known Bug

The heading anchor extension only adds id attributes; it does not render a visible link icon. Add your own CSS/JS if you want clickable anchors.

Use standard HTML <details> and <summary> tags in your Markdown files for collapsible content. The default theme styles them automatically.

<details>
<summary>Click to reveal</summary>

Hidden content with **Markdown formatting**.

</details>

See the Markdown markup test for a live example.