Skip to content
master
Go to file
Code
This branch is even with jbake-org:master.

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.asciidoc

JBake

JBake

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

Build Status Appveyor Status Coverage Status Maven Download Bintray Download Homebrew Download

Gitter Chat

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:

Talk to other users of JBake on the forum:

Build System

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

$ ./gradlew distZip

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

For more information see Test, Build and Deploy

Coding conventions

The project uses a basic set of checkstyle rules to keep the Code in shape.

We configured the gradle checkstyle Plugin to run with the check task. It does not break the build if convention violations are found. But prints a warning and generates a report.

For more information see Test, Build and Deploy

Setup Intellij

  • Install checkstyle-idea plugin

    Settings → Plugins → CheckStyle-IDEA

  • Configure

    Settings → Other Settings → Checksytle

    Add a new Configuration File. Enter a Description like "jbake Checkstyle" and choose "Use a local Checkstyle file". The checkstyle File is located at the project root path config/checkstyle/checkstyle.xml

  • Add to Editor Code Style Scheme

    Settings → Editor → Code Style

    Click the gear Symbol besides the "Scheme:" drop-down.

    Import Scheme → Checkstyle Configuration

    Pick the project checkstyle file config/checkstyle/checkstyle.xml

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

About

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

Resources

License

Packages

No packages published
You can’t perform that action at this time.