mvn-site

generates project documentation website

TLDR

Generate project site

$ mvn site

Generate and deploy site

$ mvn site-deploy

Generate site in specific directory

$ mvn site -DoutputDirectory=[docs]

Run site with reports

$ mvn site -DgenerateReports=true

Stage site locally

$ mvn site:stage

Clean and regenerate

$ mvn clean site

SYNOPSIS

mvn site [options]

DESCRIPTION

mvn site generates project documentation website. It creates HTML from project metadata.The goal produces reports, JavaDocs, and info pages. Configured via pom.xml reporting section.

PARAMETERS

site

Generate project website.

site-deploy

Deploy site to server.

site:stage

Stage site locally.

-DoutputDirectory DIR

Output location.

-DgenerateReports BOOL

Include reports.

--help

Display help information.

CAVEATS

Requires site configuration. Heavy dependency download. Plugins control content.

HISTORY

The Maven Site Plugin is part of Apache Maven for generating project documentation sites.