jbake-org / jbake-maven-plugin

JBake Maven Plugin - NOTE: Code now resides in main JBake repository - https://github.com/jbake-org/jbake
9 stars 15 forks source link
build-tool maven maven-plugin static-site-generator

= JBake Maven Plugin Jonathan Bullock 2021-04-20 :idprefix:

image:https://maven-badges.herokuapp.com/maven-central/org.jbake/jbake-maven-plugin/badge.svg[link="https://maven-badges.herokuapp.com/maven-central/org.jbake/jbake-maven-plugin"]

JBake Maven Plugin is a Maven plugin allowing you to integrate http://jbake.org[JBake] into your projects build. This is the official version published at the following Maven coordinates:


org.jbake jbake-maven-plugin 0.3.4

Special thanks must go to the original author of this plugin - https://github.com/aldrinleal[Aldrin Leal].

== Usage

To use JBake Maven Plugin in your build add the plugin into your pom.xml as shown below:


... ... org.jbake jbake-maven-plugin 0.3.4 default-generate generate-resources generate ... ...

=== Dependencies

The plugin itself includes all required dependencies such as jbake-core, however you will need to explicitly declare dependencies for the content formats and template engines used in your project. As these dependencies are marked as optional to reduce bloat.

If you have AsciiDoc content you'll need this dependency:


org.asciidoctor asciidoctorj 2.4.3

If you have Markdown content you'll need these dependencies:


com.vladsch.flexmark flexmark 0.62.2 com.vladsch.flexmark flexmark-profile-pegdown 0.62.2

If you have Freemarker templates then you'll need this dependency:


org.freemarker freemarker 2.3.31

If you have Groovy templates then you'll need these dependencies:


org.codehaus.groovy groovy 3.0.7 org.codehaus.groovy groovy-templates 3.0.7 org.codehaus.groovy groovy-dateutil 3.0.7

If you have Thymeleaf templates then you'll need this dependency:


org.thymeleaf thymeleaf 3.0.12.RELEASE

If you have Jade4J templates then you'll need this dependency:


de.neuland-bfi jade4j 1.3.2

An example of the plugin being used can be found in this project: https://github.com/jonbullock/maven-jbake-site[https://github.com/jonbullock/maven-jbake-site]

== Goals

There are 4 goals provided by this plugin:

You can also more details on each goal by running the help goal:


$ mvn jbake:help -Ddetail # -DgoalName=[seed|generate|watch|inline]

== Versioning

The project adopts the http://semver.org[Semantic Versioning] spec to maintain an understandable backwards compatibility strategy.

The version format is as follows:


..-