Anakia to Maven

This document has been specifically created for users of Anakia. If you use Anakia to generate a website for your project, you can easily migrate to Maven and automatically inherit a great look and feel designed by CSS experts. This is an ideal opportunity for you to start integrating Maven into your project. Using Maven is not an all or nothing scenario, with very little effort you can use Maven to generate only your site documentation. As you become more familiar with Maven, you can then slowly start utilizing other features of Maven.

The process of creating a Maven-generated site from your Anakia documentation is outlined below:

  • Install Maven on your system. Please refer to the Getting Started documentation for assistance.
  • Create a project descriptor and refer to the Integration document for assistance. You'll also be able to change the default colors used by Maven when generating your site by setting the appropriate properties. If you are only interested in using Maven for the generation of your site (and not compilation), you do not have to complete the <build> element section of the project descriptor.
  • Use Maven to generate your site by invoking the maven site goal. You can also automatically deploy your site to a web server with maven site:deploy.

If your project does not store its documentation in the xdocs directory located in the base directory of the project, you'll have to define the property ${maven.docs.src} in a properties file or via the command line to point to the appropriate location.

Prior to writing this document, several random Jakarta projects were selected and their documentation was generated using Maven to demonstrate how easy it is to switch from Anakia to Maven. Give it a try, we promise you'll like it!

Anakia Extensions

See Site Navigation for more information about Maven extensions to Anakia.