Did you know...

Table of Contents

The Maven Site plugin uses by default the apt format. Although it is a simple and straight forward format I personally prefer the Confluence markup and DocBook. Confluence I use for my personal Wiki and at various projects I use DocBook for the documentation.

Under the hood of the Maven site plugin runs the Doxia plugin. The documentation of the Site plugin is not really clear on this part. I stumbled on this some time ago.

By adding the appropriate doxia module as a dependency to the site plugin you can use the following formats:

[Apt](http://maven.apache.org/doxia/references/apt-format.html)Almost Plain Text[doxia-module-apt](http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-apt/)
[Confluence](http://maven.apache.org/doxia/modules/index.html#Confluence)Confluence Enterprise Wiki[doxia-module-confluence](http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-confluence/)
[Simplified DocBook](http://maven.apache.org/doxia/modules/index.html#Simplified_DocBook)Simplified DocBook XML Standard[doxia-module-docbook-simple](http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-docbook-simple/)
[FML](http://maven.apache.org/doxia/references/fml-format.html)FAQ Markup Language[doxia-module-fml](http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-fml/)
[iText](http://maven.apache.org/doxia/modules/index.html#iText)iText PDF Library[doxia-module-itext](http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-itext/)
[FO](http://maven.apache.org/doxia/modules/index.html#FO)*XSL formatting objects (XSL-FO)[doxia-module-fo](http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-fo/)
[LaTeX](http://maven.apache.org/doxia/modules/index.html#LaTeX)LaTeX typesetting system[doxia-module-latex](http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-latex/)
[Markdown](http://maven.apache.org/doxia/modules/index.html#Markdown)**Markdown markup language[doxia-module-markdown](http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-markdown/)
[RTF](http://maven.apache.org/doxia/modules/index.html#RTF)Microsoft Rich Text Format[doxia-module-rtf](http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-rtf/)
[TWiki](http://maven.apache.org/doxia/modules/index.html#TWiki)*TWiki Structured Wiki[doxia-module-twiki](http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-twiki/)
[Xdoc](http://maven.apache.org/doxia/references/xdoc-format.html)XML Documentation Format[doxia-module-xdoc](http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-xdoc/)
[XHTML](http://maven.apache.org/doxia/modules/index.html#XHTML)Extensible Hypertext Markup Language[doxia-module-xhtml](http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-xhtml/)
 

Adding the following code snippet to you pom allows you to use the specified markup language for you site.

<pluginManagement>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-site-plugin</artifactId>
      <version>2.1.1</version>
      <configuration>
        <locales>en</locales>
      </configuration>
      <dependencies>
        <dependency>
          <groupId>org.apache.maven.doxia</groupId>
          <artifactId>doxia-module-confluence</artifactId>           <version>1.1.3</version>
        </dependency>
      </dependencies>
    </configuration>
  </plugin>
 </plugins>
</pluginManagement>

Related Posts

Why I think builds should be reproducible

Today I was reading DZone and cam across this article “Maven the Version Number Nazi. First of all I think the word Nazi is inappropriate but that’s besides the point made by the author.

Read More

Adding your artifacts to the public maven repo

Ever had a project that you want to share with every body and not want them to get your source code, build and install it public repository?

Read More