Coder Social home page Coder Social logo

nathos / amicus Goto Github PK

View Code? Open in Web Editor NEW
163.0 5.0 28.0 1.05 MB

Amicus is a clean project template for the Middleman static site generator. It includes HTML5 Boilerplate, the awesome Susy grid system, and lots of best practices.

Home Page: https://github.com/nathos/amicus

License: MIT License

Ruby 27.71% JavaScript 55.10% CSS 17.19%

amicus's Introduction

Amicus: your expert toolkit for rapid web prototyping

What is it?

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.

It's Responsive!

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.

How do I use it?

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 http://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 Template

Middleman now supports project templates. To use Amicus as a template, clone the Git repository into ~/.middleman, like so:

git clone http://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!

What other cool stuff is in here?

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.

Comments & Suggestions?

Send me a message or submit an issue. Thanks!

License

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

amicus's People

Contributors

nathos avatar paperdigits avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

amicus's Issues

HTML5 Boilerplate 3

Hi and thanks for a great job on your Middleman bootstrap!

I was just wondering if you have any plans on updating it to HTML5 Boilerplate 3?

Middleman 2

Just wondering if you were planning to update the bootstrap to work with Middleman 2?

Thanks.

<html> tag not closed

Hi Nathan,

I just noticed that (I'm presuming) due to the IE conditional comments around the <html> tags, the closing </html> isn't being added by the HAML parser..

Any suggestions how to work around this?

Cheers,

Michael

h5bp-helpers not included

h5bp has some useful helper methods. For example .visuallyhidden (to hide something but still make it accessible for screenreaders).

@include h5bp-helpers

should be added to screen.css.sass

Update to support Middleman 3.0

Lots of good new stuff in MM 3.0. There are some fundamental changes, so this is probably a good time to refactor the entire project.

Site example please

Hi, That would be glad to add a link to a site build with amicus. Thanks, Laurent

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.