Maven Doxia

Doxia is the document engine behind every Maven site. It reads the pages you write in Markdown, APT, Xdoc, FML or XHTML and the reports that plugins generate, and turns them into HTML. When you run mvn site, the Maven Site Plugin uses Doxia to do the work.

The current release of Doxia is 2.2.0.

Write a site

You don't need to install or configure Doxia: the Maven Site Plugin includes every format listed here. Put your pages under src/site/<format>/ and run mvn site. The guide to creating a site covers the whole setup.

Write a plugin report or extend Doxia

Report plugins write their output through the Doxia Sink API, which keeps them independent of the output format.

Components

Doxia is released as three components.

Component What it does
Doxia The Sink API, the parsers and sinks for each format, and the macros.
Doxia Sitetools The site model (site.xml) and the renderer that applies a skin to the pages.
Doxia Tools Stand-alone tools, such as the Doxia Converter, which converts a document from one format to another.

All components are published to Maven Central under the org.apache.maven.doxia group ID, see Downloads.

History

Doxia is based on the Aptconvert project by XMLmind, was first hosted at Codehaus, and became a Maven subproject in 2006. Doxia 2.0, released in 2024, moved the output to HTML5 and removed the PDF, LaTeX, RTF, DocBook, Confluence and TWiki modules; see Former Doxia Formats.