flatrack

About

A simple rack web layer for delivering rendered static files.

Installation

$ gem install flatrack

Creating your Flatrack site

$ flatrack new my-website

Structure

You should have 4 directories:

- assets
- layouts
- pages
- partials

Assets

Location of sprockets assets, flatrack comes with Sass and Coffeescript out of the box.

- images
- javascripts
- stylesheets

Pages

Pages are the guts of your site, this is what your users will ultimately see. Basically put your content here.

Layouts

Layouts are the skin of your site, it's what takes all those guts that your users need and crave and puts them in a nice pretty layout for them to enjoy.

You can also define a custom layout using the following syntax:

<!-- /pages/my-view.html.erb -->
<%- use_layout :custom_layout %>
<p>Hello World</p>

Running your site

$ flatrack start

How it works

Anything in /pages maps to a URL at /, root of a directory will always map to the index.html.* file in it.

for example

GET /foo.html would map to /pages/foo.html.erb, the erb (or any other format) is optional if you wish to render your pages dynamically.

Templating Support

Built in

• HTML
• ERB
• Ruby Evaluated Output

Extensions

• HAML (haml-flatrack)
• Markdown (redcarpet, bluecloth)
• Textile (Redcloth)
• and more! (see Tilt for more details.)

Sites using flatrack

Pull Request to add yours!

• jasonwaldrip.com
• carlypaige.com

Contributing

• Fork it ( http://github.com/jwaldrip/flat-rack/fork )
• Create your feature branch (git checkout -b my-new-feature)
• Commit your changes (git commit -am 'Add some feature')
• Push to the branch (git push origin my-new-feature)
• Create new Pull Request