hu19891110 / jbake

Java based open source static site/blog generator for developers & designers.

JBake

JBake

JBake is a Java based open source static site/blog generator for developers.

Documentation

Full documentation is available on jbake.org.

Contributing

We welcome all contributions to the project both big and small. From new features, bug reports to even spelling mistake corrections in the documentation. Please don’t hesitate to submit an issue.

The Contributing guide provides information on how to submit an issue or create a pull request to fix a bug or add a new feature to JBake.

Versioning

The project has adopted the Semantic Versioning spec from v2.2.0 onwards to maintain an understandable backwards compatibility strategy.

The version format is as follows:

<major>.<minor>.<patch>-<label>

• An increment of the major version represents incompatible API changes.

• An increment of the minor version represents additional functionality in a backwards-compatible manner.

• An increment of the patch version represents backwards-compatible bug fixes.

• Existence of a label represents a pre-release or build metadata.

Community

Talk to the developers behind JBake:

• Mailing list

• IRC - #jbake on Freenode

Talk to other users of JBake on the forum:

• Forum

Build System

The project uses Apache Maven as the build system. To build the JBake distribution ZIP file execute the following command from the root of the repo:

$ mvn package

This will build a ZIP file in the /dist folder.

Alternatively you can run directly from the source code using the Maven exec plugin:

$ mvn exec:java -Dexec.mainClass=org.jbake.launcher.Main -Dexec.args="/fromFolder /tmp/toFolder/"

Tools & Libraries Used

• Apache Commons IO, Configuration, Lang & Logging

• Apache Maven

• Args4j

• AsciidoctorJ

• Eclipse IDE

• Freemarker

• JUnit

• Pegdown

• Jetty Server

• OrientDB

• Groovy

Copyright & License

Licensed under the MIT License, see the LICENSE file for details.