Doxia Markup Languages References

The following table gives an overview of the markup languages currently supported by Doxia:

• if a Parser is available for a given format, it means that you can write your documentation in this language and Doxia can generate output from it,

• if a Sink is available, it means you can generate output in this format.

The source directory is the directory under which Maven expects source documents in this format (e.g. src/site/apt/ for Apt), the file extension is the default file extension, and the parser id is gives the unique identifier that is used by plexus to lookup the corresponding component.

Format	Short description	Parser (input)	Sink (output)	Source Directory	File Extension	Doxia Module	Parser Id
Apt	Almost Plain Text			apt	apt	doxia-module-apt	apt
AsciiDoc	Asciidoctor Converter Doxia Module, only emits Sink.rawText()			asciidoc	adoc, asciidoc	asciidoctor-converter-doxia-module	asciidoc
AsciiDoc	Asciidoctor Parser Doxia Module, still in beta			asciidoc	adoc, asciidoc	asciidoctor-parser-doxia-module	asciidoc
FML	FAQ Markup Language			fml	fml	doxia-module-fml	fml
Markdown	Markdown markup language			markdown	md, markdown	doxia-module-markdown	markdown
Xdoc	XML Documentation Format			xdoc	xml	doxia-module-xdoc	xdoc
XHTML	Extensible Hypertext Markup Language			xhtml	xhtml	doxia-module-xhtml	xhtml

Note some modules are not included per default with the site plugin. Have a look at the available modules here: https://repo.maven.apache.org/maven2/org/apache/maven/doxia/.

If you need to add module for the maven-site-plugin simply add it as a dependency of the plugin:

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-site-plugin</artifactId>
  <version>...</version>
  <dependencies>
    <dependency>
      <groupId>org.apache.maven.doxia</groupId>
      <artifactId>doxia-module-markdown</artifactId>
      <version>...</version>
    </dependency>
  </dependencies>
</plugin>

Former Doxia Formats

The following table gives an overview of the formats which used to be supported mostly as Parser in former versions of Doxia: