Generate a documentation site for Maven project

In this section, you will learn to auto generate a documentation site with default design and pages for your Maven based project.

Generate a documentation site for Maven project

Generate a documentation site for Maven project

In this section, you will learn to auto generate a documentation site with default design and pages for your Maven based project.

For auto generating default structured documentation site for your maven based project, you need to utilize following command :

mvn site

This command will auto generate a documentation site with default design and pages for your Maven based project.

Note: If you are unaware of creating web application using maven click here.

The above command will auto generate default structured documentation site with default design and pages  for your Maven based project. This auto generates site is under your project's target/site directory.

The project's auto generated documentation looks like this :

Tutorials

  1. Maven2 Tutorial
  2. Introduction to Maven 2
  3. Maven 2: Features
  4. Shifting from Ant to Maven
  5. Common concerns to build a project
  6. Maven basics
  7. Repository
  8. Apache Maven plugins
  9. Installing and Getting Hands on Maven
  10. A Maven2 Repository : An Introduction
  11. Learn to Set Up An Internal Private Repository For An Organization
  12. Directory Structure of Artifactory-1.2.2
  13. Deployment in Tomcat 6.0
  14. Navigating Artifactory
  15. Maven 2 Eclipse Plug-in
  16. Develop java persistence example with Maven2
  17. Maven2 Tutorial
  18. create web application using maven
  19. maven jetty plugin
  20. Maven Compiler Plugin
  21. Enable Proxy Setting
  22. Change Local Repository
  23. Maven remote repository
  24. Generate a documentation site for Maven project
  25. Convert Maven based web application to support eclipse
  26. Create project from Maven Template