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.
$ gem install usmu
You can generate a new basic website using
$ usmu init site-name
This will create a new site in the
site-name folder. You can now use
usmu generate to build the test site.
$ cd site-name $ usmu generate
You can also use
usmu serve to get a live server that you can use to test changes you make. This will not modify any
files in your output folder but will instead dynamically generate and serve content directly from your files. Note,
this is in no way secure and it is highly recommended to only deploy static versions of your website.
$ usmu serve
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
slim: :pretty: true