Stylio

Stylio is a Sinatra based frameowrk to make a living styleguide that can easily be ported into a Rails application.

Currently supports Sass and ERB

Installation

Add this line to your application's Gemfile:

gem 'stylio'

And then execute:

bundle install

Or install it yourself as:

gem install stylio

Add framework folders

mkdir components && mkdir layouts

Usage

Run stylio in your project folder to start the server.

See (stylio-example)[http://github.com/substrakt/stylio-example] to see an example setup.

Stylesheets are added to the assets/stylesheets folder which you will need to create.

Adding components

mkdir COMPONENT_NAME and then add two files in this folder:

An erb partial touch _COMPONENT_NAME.html.erb A fixture file touch COMPONENT_NAME.yml

The root level yaml parameters create multiple examples of the partial. Any data below the root level is accessed in the partial e.g. <%= params[:title] %>

See (stylio-example)[http://github.com/substrakt/stylio-example] to see an example setup.

Adding layouts

mkdir LAYOUT_NAME and then add a file in this folder:

An erb template touch LAYOUT_NAME.html.erb

No parameters can be referenced on this page except for <%= yield_example %>. When moving to a Rails app, simply change yield_example to yield

See (stylio-example)[http://github.com/substrakt/stylio-example] to see an example setup.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/substrakt/stylio. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.