thoughtbot Middleman Starter

About

This starter kit for Middleman follows the thoughtbot styleguide and includes our favorite front end tools.

About Middleman

Middleman is a static site generator built in Ruby. This makes it a great fit for projects that may end up as a Ruby on Rails app. Its minimalistic structure makes it very easy to work with, and includes support for deploying to Github Pages.

Includes

HAML: Simple template markup
Coffeescript: Write javascript with simpler syntax
Sass (LibSass): CSS with superpowers
Bourbon: Sass mixin library
Neat: Semantic grid for Sass and Bourbon
Bitters: Scaffold styles, variables and structure for Bourbon projects.
Middleman Live Reload: Reloads the page when files change
Middleman Deploy: Deploy your Middleman build via rsync, ftp, sftp, or git (deploys to Github Pages by default)

We also recommend Refills for prepackaged interface patterns and Proteus for a collection of useful starter kits to help you prototype faster.

Getting Started

Set up your project in your code directory

git clone https://github.com/thoughtbot/proteus-middleman.git your-project-folder
cd your-project-folder
git remote rm origin
git remote add origin your-git-url

Install dependencies:

bundle install

Run the server

bundle exec middleman

Deploy to Github Pages

bundle exec middleman deploy

Or install the Proteus gem and enjoy some shortcuts.

Directories

Stylesheets, fonts, images, and JavaScript files go in the /source/assets/ directory. Vendor stylesheets and JavaScripts should go in each of their /vendor/ directories.

Contributing

If you have problems, please create a GitHub Issue.

Have a fix or want to add a feature? Pull Requests are welcome!

Credits

thoughtbot Middleman Starter is maintained and funded by thoughtbot, inc. Thank you to all of the contributors!

legitbs/cgc-docs