usmu

Source: https://github.com/usmu/usmu
Author: Matthew Scharley
Contributors: See contributors on GitHub
Bugs/Support: Github Issues
Copyright: 2014
License: MIT license
Status: Active

Synopsis

usmu is a static site generator intended to be used with the future Rails-based editing platform. It can also be used to generate locally if you don't wish to use the web-based editor.

Installation

$ gem install usmu

Usage

TODO: Write usage instructions here

Compatibility

As a baseline usmu will pull in Slim for layouts and Redcarpet for content written in Markdown. However we use the Tilt API to render all layouts and content, therefore you should be able to use anything supported by Tilt including Sass, Less, Textile and many others, you just need to ensure you have the correct gems installed.

If you want to further configure the way your template's are processed then you can specify configurations for each template engine. Just add it to your usmu.yml:

slim:
  :pretty: true

Ruby Compatibility

Officially, we support MRI 1.9.3 and onwards, however we recommend the latest versions. 1.9.3 is no longer maintained and is only supported here to help out the Rubinius and JRuby folks.

We only officially support MRI, however Travis does run against both Rubinius and JRuby to track compatibility and there's a reasonable track record so far. Compatibility patches are very welcome.