No description
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2014-06-13 16:25:42 -04:00
bin Made the executable executable 2014-06-13 16:19:01 -04:00
lib Rename of compile method and update gitignore 2014-06-13 15:37:43 -04:00
.gitignore Rename of compile method and update gitignore 2014-06-13 15:37:43 -04:00
Gemfile Added dependencies for compilers 2014-06-13 16:21:12 -04:00
LICENSE.txt Initial commit 2014-06-13 15:32:39 -04:00
Rakefile Initial commit 2014-06-13 15:32:39 -04:00
README.md Updated README as gem is now deployed 2014-06-13 16:25:42 -04:00
tv_snow.gemspec Added homepage 2014-06-13 16:22:09 -04:00

TV Snow

A Ruby gem for compiling static sites!

Installation

The installation here is super hard. You run:

$ gem install tv_snow

Then you're finished! You survived!

Usage

Build your site with your favorite Ruby tools!

First, you should have the following directories in your project (but each is optional):

  • css, which should hold all your Sass and CSS files
  • js, which should hold all your Coffeescript and JS files
  • img, which should hold all your images

All of your Haml or Slim files should just be at the root of the project. Someday, I should probably add support for directory structures. Maybe today.

Note: When you link to a stylesheet written in Sass, do not add the scss ending to the file name. So linking to the styles contained in css/default.css.scss, in Haml you would write:

%link{rel: 'stylesheet', href: 'css/default.css'}

Contributing

  1. Fork it ( https://github.com/J3RN/tv_snow/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

There is so much to do! I'm sorry for the very unfinished-ness of this app, and would love your help!