Amicus is a clean project starting point for the Middleman static site generator. It features HTML5 Boilerplate, Haml, Sass, Compass, Susy grid system, and lots of best practices.
Amicus now comes with a mobile-first responsive grid system by default (see source/stylesheets/grid/_magic.sass). Based on the Susy "Magic" grid system, it's ready to customize for your projects.
Start by installing Bundler, if you don't already have it:
gem install bundler
Then just download the latest source or if you prefer, clone the repository down to your local machine:
git clone https://github.com/nathos/amicus.git my_new_project
Finally, do a bundle install to install the required gems -- even Middleman itself!
Use middleman to do your live development and middleman build to render your static file output to the /build/ directory.
For full Middleman documentation, visit the Middleman website.
Middleman now supports project templates. To use Amicus as a template, clone the Git repository into ~/.middleman, like so:
git clone https://github.com/nathos/amicus.git ~/.middleman/amicus
then use the new template argument for the middleman init command:
middleman init my_new_project --template=amicus
Easy peasy!
The default Haml layout is based on HTML5 Boilerplate, and is fully commented. (Don't worry, those comments aren't rendered out to your build directory)
Susy is the default grid system.
An included Ruby helper method to generate image placeholders, powered by Holder.js.
Send me a message or submit an issue. Thanks!
Following the lead of HTML5 Boilerplate here...
Major components:
- HTML5 Boilerplate: MIT license
- Normalize.css: MIT license
- Modernizr: MIT/BSD license
- jQuery: MIT/GPL license
- Susy: MIT license
Everything else:
- MIT license -- see LICENSE.md