fj-doc-guides

Creates a new project already configured for Venus

Index

It is possible to use the org.fugerit.java:fj-doc-maven-plugin:init maven plugin in order initialize a new project, it is as simple as running :

mvn org.fugerit.java:fj-doc-maven-plugin:init \
-DgroupId=org.example.doc \
-DartifactId=fugerit-demo

A new folder $artifactId folder will be created, containing the maven project configured for using Venus.

For additional options see documentation.

Some use cases

Select the needed Venus Extensions

For instance, if PDF, CSV and XLSX output are needed :

-Dextensions=base,freemarker,mod-fop,mod-csv,mod-poi

Here is the complete command :

mvn org.fugerit.java:fj-doc-maven-plugin:init \
-DgroupId=org.example.doc \
-DartifactId=fugerit-demo \
-Dextensions=base,freemarker,mod-fop,mod-opencsv,mod-poi

Flavoured project

With the ‘flavour’ parameter, it is possible to create specific project type (among the supported ones).

I.e. to create a quarkus 3 project :

-Dflavour=quarkus-3

Here is the full command :

mvn org.fugerit.java:fj-doc-maven-plugin:init \
-DgroupId=org.example.doc \
-DartifactId=fugerit-demo-quarkus-3 \
-Dflavour=quarkus-3 \
-Dextensions=base,freemarker,mod-fop,mod-opencsv,mod-poi

See fj-doc-maven-plugin init goal documentation for further info

This site is open source. Improve this page.