Skip to content

Support Markdown as a standalone report output format - #278

Draft
slachiewicz wants to merge 2 commits into
apache:masterfrom
slachiewicz:markdown-output-format
Draft

slachiewicz wants to merge 2 commits into
apache:masterfrom
slachiewicz:markdown-output-format

Conversation

@slachiewicz

@slachiewicz slachiewicz commented Nov 18, 2026 •

Copy link
Copy Markdown
Member

A report run as a standalone goal can write Doxia markup instead of a skinned HTML page with -Doutput.format=<format>, but only formats whose Doxia module is on the plugin's classpath work, which were xdoc, apt and xhtml. This adds doxia-module-markdown at runtime, so -Doutput.format=markdown writes the report as Markdown, for example to publish it in a repository wiki or a pull request comment.

The output file keeps the existing naming, <outputPath>.<format>, so it ends in .markdown. The module brings flexmark along: 27 jars, about 2 MB, in every report plugin that depends on this library. They are only used for standalone runs; during mvn site the site plugin supplies Doxia. A lighter alternative is to leave the module out and document adding doxia-module-markdown as a plugin dependency, which works without this change. The site index now lists the four formats.

Verified: mvn -P run-its verify → 6 ITs pass; without the new dependency the extended use-as-direct-mojo-markup IT fails with "Cannot find SinkFactory for Doxia output format: markdown".


Adds doxia-module-markdown at runtime so -Doutput.format=markdown finds a SinkFactory. It brings flexmark (27 jars, about 2 MB) into every report plugin built on this library; the output file keeps the <outputPath>.<format> naming, so it ends in .markdown.
@slachiewicz slachiewicz added the enhancement New feature or request label Nov 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant