Git Product home page Git Product logo

middleman-bootstrap's Introduction

Middleman Bootstrap

What is it?

Middleman Bootstrap is my clean project starting point for the Middleman static site renderer. It includes HTML5 Boilerplate, Haml, Sass, Compass, a Mobile-first Responsive Susy grid system, and lots of best practices.

Now it's Responsive!

Middleman Bootstrap now comes with a Mobile-first Responsive grid system by default. Inspired by 320 and up and 320+Susy, the basic skeleton for a fully responsive layout is ready for you to use in your projects.

Put your responsive grid declarations in the /stylesheets/grid/media/ partials, and your width-specific styles in the /stylesheets/media/ partials. Remember, it's mobile-first, so your styles cascade up with larger browser widths.

How do I use it?

Start by installing Bundler, if you don't already have it:

gem install bundler

Then just download the latest bootstrap source or if you prefer, clone the bootstrap repository down to your local machine:

git clone http://github.com/nathos/middleman-bootstrap.git my_new_project

Finally, do a bundle install to install the required gems -- even Middleman itself!

Use middleman server 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 2.0 Template

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

git clone http://github.com/nathos/middleman-bootstrap.git ~/.middleman/mm-bootstrap

then use the new template argument for the middleman init command:

middleman init my_new_project --template=mm-bootstrap

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. However, you can enable the 960.gs grid system by uncommenting the appropriate lines in config.rb and the main screen.css.sass file. The other grid partials (_960gs.sass & _blueprint.sass) include a basic grid setup with comments.

(Note: Blueprint is built into Compass, so you can use its grid system just by uncommenting the appropriate @import line in screen.css.sass.)

I've taken a shine to Resonsive Design and the Susy flexible grid system, so I may deprecate Blueprint & 960.gs in a future version.

Comments & Suggestions?

Send me a message or submit an issue. Thanks!

License

Following the lead of HTML5 Boilerplate here...

Major components:

  • Modernizr: MIT/BSD license
  • jQuery: MIT/GPL license
  • Respond.js: MIT/GPL license
  • YUI Profiling: BSD license
  • HTML5Doctor CSS reset: Public Domain
  • CSS Reset Reloaded: Public Domain
  • Blueprint CSS: MIT license
  • 960.gs: MIT/GPL license
  • Susy: MIT license

Everything else:

middleman-bootstrap's People

Contributors

nathos avatar

Stargazers

Stefano Pigozzi avatar

Watchers

Stefano Pigozzi avatar James Cloos avatar

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.