Skip to content
This repository was archived by the owner on Oct 25, 2024. It is now read-only.

Commit ee67922

Browse files
committed
Added fj-doc-maven-plugin init goal docs
1 parent 231a366 commit ee67922

File tree

1 file changed

+40
-1
lines changed

1 file changed

+40
-1
lines changed

src/docs/wizard/fj-doc-maven-plugin_init.md

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,43 @@ mvn org.fugerit.java:fj-doc-maven-plugin:init \
1212

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

15-
For additional options see [documentation](https://github.com/fugerit-org/fj-doc/blob/main/fj-doc-maven-plugin/README.md#goal--init).
15+
For additional options see [documentation](https://github.com/fugerit-org/fj-doc/blob/main/fj-doc-maven-plugin/README.md#goal--init).
16+
17+
## Some use cases
18+
19+
### Select the needed Venus Extensions
20+
21+
For instance, if PDF, CSV and XLSX output are needed :
22+
23+
`-Dextensions=base,freemarker,mod-fop,mod-csv,mod-poi`
24+
25+
Here is the complete command :
26+
27+
```shell
28+
mvn org.fugerit.java:fj-doc-maven-plugin:init \
29+
-DgroupId=org.example.doc \
30+
-DartifactId=fugerit-demo \
31+
-Dextensions=base,freemarker,mod-fop,mod-opencsv,mod-poi
32+
```
33+
34+
### Flavoured project
35+
36+
With the 'flavour' parameter, it is possible to create specific project type (among the supported ones).
37+
38+
I.e. to create a quarkus 3 project :
39+
40+
`-Dflavour=quarkus-3`
41+
42+
Here is the full command :
43+
44+
```shell
45+
mvn org.fugerit.java:fj-doc-maven-plugin:init \
46+
-DgroupId=org.example.doc \
47+
-DartifactId=fugerit-demo-quarkus-3 \
48+
-Dflavour=quarkus-3 \
49+
-Dextensions=base,freemarker,mod-fop,mod-opencsv,mod-poi
50+
```
51+
52+
See [fj-doc-maven-plugin init goal documentation for further info](https://github.com/fugerit-org/fj-doc/blob/main/fj-doc-maven-plugin/README.md#init-fugerit-venus-parameters)
53+
54+

0 commit comments

Comments
 (0)