Tools :: DocumentationDocs

Menu

yupiik-tools:generic-static-generator

Generate a static plain text file (html, json, ...) based on customizable context.

Coordinates

<plugin>
  <groupId>io.yupiik.maven</groupId>
  <artifactId>yupiik-tools-maven-plugin</artifactId>
  <version>1.3.1-SNAPSHOT</version>
</plugin>

To call this goal from the command line execute: mvn yupiik-tools:generic-static-generator.

To bind this goal in the build you can use: 

<plugin>
  <groupId>io.yupiik.maven</groupId>
  <artifactId>yupiik-tools-maven-plugin</artifactId>
  <version>1.3.1-SNAPSHOT</version>
  <executions>
    <execution>
      <id>my-execution</id>
      <goals>
        <goal>generic-static-generator</goal>
      </goals>
      <configuration>
        <!-- execution specific configuration come there -->
      </configuration>
    </execution>
  </executions>
</plugin>

You can execute this goal particularly with mvn yupiik-tools:generic-static-generator@my-execution command.

Configuration

TIP

* means the parameter is required.

template* (String)

Handlebars template to render once the context is built. Property: ${yupiik.generic-static-generator.template}.

contributors (List)

List of contributors to generate the output. Default value: java.util.List.of(). Property: .

output (String)

Where to write the output. STDOUT and STDERR are two specific values for the standard outputs. Default value: STDOUT. Property: ${yupiik.generic-static-generator.output}.

partials (Map)

Partials handlebars. Property: ${yupiik.generic-static-generator.partials}.

threads (int)

Size of the thread pool to run contribution in. Default value: 1. Property: ${yupiik.generic-static-generator.threads}.

Navigation