sandeep gupta

Shire


Source: https://github.com/sangupta/shire
License: http://www.apache.org/licenses/LICENSE-2.0

Shire is a blog-aware static site generator modelled around the famous Jekyll. It also tends to pull in features from the Octopress. The project is under heavy development as this also serves my home site :)

Current Version: 0.1.0

Usage

The project is still under development and hence, is not usable directly via the command line.

To use sync the code base and set it up as a project in your favorite IDE. Shire is a Maven-based JAVA project. Once the project is setup, open the JAVA class Shire and in the main method, setup the path to your YAML config file.

Features

  • Support for Apache Velocity Templates
  • Support for multiple includes and layouts
  • Support for YAML and XML based configuration

Downloads

You can download the JAR from the Downloads page.

Alternatively, you may download the builds from Maven Central repository using:

<dependency>
    <groupId>com.sangupta</groupId>
    <artifactId>shire</artifactId>
    <version>0.1.0</version>
</dependency>

Dependencies

Currently, Shire does not depend on any third-party binary.

Versioning

For transparency and insight into our release cycle, and for striving to maintain backward compatibility, Bootstrap will be maintained under the Semantic Versioning guidelines as much as possible.

Releases will be numbered with the follow format:

<major>.<minor>.<patch>

And constructed with the following guidelines:

  • Breaking backward compatibility bumps the major
  • New additions without breaking backward compatibility bumps the minor
  • Bug fixes and misc changes bump the patch

For more information on SemVer, please visit http://semver.org/.

License

Copyright 2012, Sandeep Gupta

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.