From 8ba2515abe8a6ec059c3359290c6d467acc62116 Mon Sep 17 00:00:00 2001 From: Geoffrey De Smet Date: Thu, 30 Dec 2021 11:46:49 +0100 Subject: [PATCH] jbake-maven-plugin: mention that all optional dependencies are now included out of the box --- jbake-maven-plugin/README.asciidoc | 94 ++++-------------------------- 1 file changed, 10 insertions(+), 84 deletions(-) diff --git a/jbake-maven-plugin/README.asciidoc b/jbake-maven-plugin/README.asciidoc index e5bd5e4a..dbfebd36 100644 --- a/jbake-maven-plugin/README.asciidoc +++ b/jbake-maven-plugin/README.asciidoc @@ -30,12 +30,10 @@ To use JBake Maven Plugin in your build add the plugin into your pom.xml as show org.jbake jbake-maven-plugin - ... + ... - + + @@ -46,9 +44,6 @@ To use JBake Maven Plugin in your build add the plugin into your pom.xml as show - - - ... @@ -58,83 +53,14 @@ To use JBake Maven Plugin in your build add the plugin into your pom.xml as show === 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. +The plugin automatically includes all optional dependencies of `jbake-core`, +including freemarker, thymeleaf, asciidoctor, flexmark (markdown), etc. +This makes it easy to get started with the plugin. +It also reduces maintenance when upgrading to a new JBake version, +because you don't need to align the versions of freemarker, thymeleaf, asciidoctor, flexmark, etc. -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 - ----- +However, if you want your build to only download the bare minimum it needs, +you can use `` to exclude the dependencies you don't need. 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]