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.
- Choose a format. Markdown is the best choice for new pages. APT and Xdoc still work, and Migrating APT to Markdown shows how to move existing pages. FML is deprecated since Doxia 2.2.0.
- Add generated content with macros, such as a table of contents (
toc) or a code excerpt from a source file (snippet). - Draw diagrams with Mermaid.
- Check what each format can and cannot express before you convert a page.
- If something renders differently from what you expect, see the FAQ and Issues and Gotchas.
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.
- Using the Sink API shows how to emit headings, tables and links.
- Creating a Doxia Macro and Creating a Doxia Module show how to add your own macro or markup format.
- The Overview explains how parsers, sinks and the site renderer fit together.
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.

