A modular static site generator with a web-based editor
Ruby HTML Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
share/init-site
spec
test-site
.gitignore
.rspec
.ruby-version
.yardopts
CHANGELOG.md
CONTRIBUTING.md
Gemfile
Guardfile
LICENSE.md
README.md
Rakefile
circle.yml
usmu.gemspec

README.md

usmu

Circle CI Dependency Status Code Climate

Source: https://github.com/usmu/usmu
Author: Matthew Scharley
Contributors: See contributors on GitHub
Bugs/Support: Github Issues
Copyright: 2016
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

You can generate a new basic website using usmu init.

$ 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

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