Built by Maven

Plugin Documentation

This report describes goals, parameters details, requirements and sample usage of this plugin.

Goals

Goals available for this plugin:

Goal Description
html:deploy-html This goal deploys the html files to a remote repository. It does use mavens wagon api to upload the generated html (and resource) files to a specified location. This is intended for quick and dirty - but up to date - documentation deployment - to a nexus 'raw' repository for example.
html:from-asciidoc This goal generates html files from asciidoc source files. It is built on top of the AsciidoctorMojo from the asciidoctor maven plugin and adapts it to align with the defined build lifecycle.
html:from-markdown This goal generates html from markdown files.
html:help Display help information on html-maven-plugin.
Call mvn html:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
html:web-resources This goal collects the web resources (images etc.) and adds them to the generated web page directory.
html:zip-html This goal zips the generated web page (html files and resources) in a zip file and attaches this zip file to the maven project, so that it will be installed and deployed by the maven default plugins.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven 3.9.0
JDK 17

System Requirements History

The following specifies the minimum requirements to run this Maven plugin for historical versions:

Plugin Version Maven JDK
from 4.0.1 to 4.0.2 - 17

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>de.eitco.cicd.html</groupId>
          <artifactId>html-maven-plugin</artifactId>
          <version>4.0.2</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>de.eitco.cicd.html</groupId>
        <artifactId>html-maven-plugin</artifactId>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"