README.adoc

jbake-sample

Example project to use JBake with Maven.

Based on the work:

• jbake-sample

  • ingenieux/jbake-sample

  • pdudits/jbake-sample

  • Fisiu/jbake-sample

  • mfandrade/jbake-sample

• JBake 2.4.0 (example project structure)

See the output online: http://jmini.github.io/jbake-sample/

Usage

Generate the site

Generate the site with JBake:

>mvn process-resources

Output is target/jbake-sample

Push to GitHub pages

Commit generate the site and push it to github pages:

>mvn site

Do not forget to provide your GitHub credentials in your settings.xml file.

See GitHub Maven Plugins for more information.

Single step run

The exec-maven-plugin is used to run the mvn command with a list of arguments. Those arguments correspond to the different goals that are requested to generate site and upload it.

To use this possibility and run everything within a single step:

>mvn exec:exec

Reusing this sample project

This setup can be reused for your own website/blog. You can copy it and adapt it to your website.

• pom.xml

  • Change the maven groupId and artifactId

  • Change the properties github.repository.owner and github.repository.name

  • Change the finalName at the beginning of the build

  • If your GitHub pages needs to commit on the master branch, adapt the site-maven-plugin configuration

• src/main/jbake/jbake.properties

  • Change the site.host variable

Who is using this setup?

• jmini/jmini.github.io

Technical description

• Templates are based on the initial groovy templates.

• Use English Locale in the date formatter (see jbake-example-project-groovy/#2)

• Add an "Edit on GitHub" link on each post/page (see discussion on the mailing-list)

• Fix relative links (see discussion on the mailing-list)

Get in touch

Use the GitHub issue tracker or @j2r2b on Twitter.