Fugerit Document Generation Framework (fj-doc)Fugerit Doc
APACHE-2.0 License
Framework to produce documents in different output formats starting from an XML document metamodel. (options for json and yaml source models are also available)
The Core library (fj-doc-base) is all you need to start, even though typically you will use at least :
Clone :
git clone https://github.com/fugerit-org/fj-doc
Full build is made by :
mvn clean install -P full,test
Or with the maven wrapper for linux :
./mvnw clean install -P full,test
Or with the maven wrapper for windows :
./mvnw clean install -P full,test
The Fugerit Venus Doc project is a library for generating documents to be included.
The module fj-doc-playground-quarkus demonstrates some of the main features.
After building, it is possible to just run it by launching :
cd fj-doc-playground-quarkus
mvn compile quarkus:dev -P buildreact
Open : http://localhost:8080/fj-doc-playground/home/
NOTE : The playground demo single page application currently runs on node 20
A quick start is available in module fj-doc-sample
There are five kinds of components (each components README.md contains module status) :
Basically the same as type handlers but based on libraries not available on Maven Repository Central (es. PDFLIB). You can find in them in a dedicated repository fj-doc-ext
Beginning with version 1.4.0-rc.001, GraalVM metadata started to be added (reflect-config.json and resources-config.json). Initially only the fj-doc-base and fj-doc-freemarker have full support. Actual support for other module will be added as soon as possible, but sometimes is dependent on underlying dependencies support (for example Apache FOP for fj-doc-mod-fop). It is possible to check the current status on the module documentation, in the section native support
A maven plugin is also available. It allows to configure a maven project for document generation, it is as simple as :
mvn org.fugerit.java:fj-doc-maven-plugin:add \
-Dextensions=base,freemarker,mod-fop
See Documentation for further details.
About javadoc Javadoc are far from being complete, but you can find latest version at https://www.fugerit.org Note that, being an open source project hosted on maven central, you can find release javadoc on javadoc.io
Special thanks
Special thanks to JetBrains for accepting this project in the Licenses for Open Source Development - Community Support program.
Special thanks to Sonar Cloud too for their code review platform.