Maven: A Developer's Notebook

Creating a Project Web Site

Maven can create a project web page, with metrics and information about a project.

How do I do that?

To create a Maven project web site, use the Site plug-in by running the following Maven goal:

C:\dev\mavenbook\code\genapp\test-application> maven site

Running the Site plug-in will create the project's web site in the default site output directory: test-application/target/docs/index.html. If you load this HTML, you will see a site with a distinctive Maven look and feel. Figure 1-5 shows a sample of a lightly customized Maven web site complete with a custom organization logo and project logo. Instead of showing you a contrived web site, you can see the site of a project currently using Maven as a build system—Jaxen.

Figure 1-5. Sample Maven project web site

Most Maven sites have a Project Documentation navigation section which provides links to information common to all Maven projects. Project Info contains information about the project, a list of the project mailing lists, and information about source control and issue tracking (you'll discover all this in Section 4.1). Content for the generated Maven web site is developed by creating and modifying XML markup in the xdocs directory. In Figure 1-5, the project contains five project-specific documents: Overview, FAQ, Releases, CVS Access, and Status. These documents are included in the left navigation bar because ...