Doxia Modules Guide

Each markup format is implemented by one Doxia module. All five modules below are part of Doxia and are included in the Maven Site Plugin, so you can use any of them without extra configuration. FML is deprecated. The format references compare them side by side, including which ones Doxia can also write and what each format cannot express.

Markdown

Use Markdown for new pages. It is the format most authors and editors already know, it renders on GitHub, and Doxia can both read and write it. Doxia follows CommonMark and adds tables, strikethrough, footnotes, definition lists, abbreviations and YAML front matter for the page title, author and date.

APT

APT (Almost Plain Text) is the original Doxia format and predates Markdown. Existing APT pages keep working, and Migrating APT to Markdown shows how to convert them.

XDoc

XDoc is an XML format with HTML-like body markup, long used on Apache project sites. It gives you more control over the HTML than APT or Markdown, at the cost of verbose sources.

FML

FML (FAQ Markup Language) is an XML format for FAQ pages: it groups questions into parts and generates the list of questions with links to the answers. Doxia can read FML but not write it.

FML is deprecated since Doxia 2.2.0 and will be removed in the next major version (apache/maven-doxia#1101). Write new FAQ pages in Markdown; the Doxia Converter converts existing .fml files.

XHTML

The doxia-module-xhtml5 module reads and writes XHTML, the XML serialization of HTML5. Use it when a page needs HTML that the other formats cannot produce. The HTML5 sink of this module also writes every page of a Maven site. The XHTML 1.0 module was removed in Doxia 2.0.