Skip to Main Content
Apache Maven Cookbook
book

Apache Maven Cookbook

by Raghuram Bharathan
April 2015
Intermediate to advanced content levelIntermediate to advanced
272 pages
4h 59m
English
Packt Publishing
Content preview from Apache Maven Cookbook

Documenting with the Maven Site plugin

Along with the clean and default lifecycle, Maven also consists of a site lifecycle. Like clean, site is implemented by a Maven plugin, in this case, the Maven Site plugin.

Getting ready

Maven is set up on your system and is verified for work. To do this, refer to the first three recipes of Chapter 1, Getting Started.

How to do it...

Use the following steps to generate documentation using the Maven Site plugin:

  1. Open one of the Maven projects for which we need to generate a site report (for instance, project-with-documentation).
  2. Run the following command:
    mvn site
    
  3. Observe the output as shown in the following screenshot:
  4. Open the index.html file generated in the target/site folder:

How it works...

Site is one of the ...

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Start your free trial

You might also like

Mastering Apache Maven 3

Mastering Apache Maven 3

Prabath Siriwardena
Learning Apache Maven

Learning Apache Maven

Kevin Bowersox

Publisher Resources

ISBN: 9781785286124Supplemental Content