Adding a Site to your Maven Project

Once you’ve got your Maven project built and sorted, one of the neat tricks you can do to make it look even more professional is to add a Maven Site. Maven gives you the ability to add a whole site structure with one simple command.

mvn archetype:generate -DarchetypeGroupId=org.apache.maven.archetypes
    -DarchetypeArtifactId=maven-archetype-site
    -DarchetypeVersion=1.0
    -DgroupId=com.company 
    -DartifactId=project 
    -Dversion=1.0 
    -Dpackage=1.5

…where all the above is on one line. This will add the following directory structure in to your project's src directory.

Generating the site from these files and pushing it into your target directory is then simply a matter of issuing the following Maven command:

mvn clean site

…and that’s all there is to it. If you open the target/site/index.html file in your browser, you’ll see something like this:

Of course there’s the little matter of adding some content and publishing it to a server somewhere, but that’s a matter for another blog.