Reflow Velocity tools

Reflow skin provides custom tools for Apache Velocity to be used in Maven site template. These objects are contributed to Velocity context and can be used within the template. Refer to Javadoc for each tool for more information.

  • SkinConfigTool (key $config)

    Provides a uniform access to Maven site custom configuration options. Supports global and per-page configuration. See info on per-page configuration in Reflow skin for an example of features it brings.

  • HtmlTool (key $htmlTool)

    Provides methods to modify and query HTML text using jsoup library.

  • URITool (key $uriTool)

    Provides URI utilities that expose URIs to the template.

Usage

To enable these tools, add reflow-velocity-tools dependency to maven-site-plugin in the POM file:

<build>
  <plugins>
    ...
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-site-plugin</artifactId>
      <version>4.0.0-M9</version>
      <dependencies>
        ...
        <dependency>
          <groupId>io.github.devacfr.maven.skins</groupId>
          <artifactId>reflow-velocity-tools</artifactId>
          <version>2.3.4</version>
        </dependency>
        ...
      </dependencies>
      ...
    </plugin>
    ...
  </plugins>
</build>