Suitstrap

A Bootstrap clone aiming for a more modular and semantic framework.

It's a combination of:

Bootstrap: A sleek, intuitive, and powerful front-end framework for faster and easier web development, created by Mark Otto and Jacob Thornton, and maintained by the core team with the massive support and involvement of the community.
SUIT principles:
SMACCS principles
Sass instead of the default LESS of Bootstrap

To get started, check out http://suitstrap.maartenvanhoof.be!

Quick start
Bugs and feature requests
Documentation
Contributing
Community
Versioning
Creators
Copyright and license

Quick start

Three quick start options are available:

Download the latest release.
Clone the repo: git clone https://github.com/vanhoofmaarten/suitstrap.git.
Install with Bower: bower install suitstrap.

Read the Getting started page for information on the framework contents, templates and examples, and more.

What's included

Within the download you'll find the following directories and files, logically grouping common assets and providing both compiled and minified variations. You'll see something like this:

suitstrap/
├── css/
│   ├── suitstrap.css
│   ├── suitstrap.min.css
│   ├── suitstrap-theme.css
│   └── suitstrap-theme.min.css
├── js/
│   ├── suitstrap.js
│   └── suitstrap.min.js
└── fonts/
    ├── glyphicons-halflings-regular.eot
    ├── glyphicons-halflings-regular.svg
    ├── glyphicons-halflings-regular.ttf
    └── glyphicons-halflings-regular.woff

We provide compiled CSS and JS (suitstrap.*), as well as compiled and minified CSS and JS (suitstrap.min.*). Fonts from Glyphicons are included, as is the optional Suitstrap theme.

Bugs and feature requests

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Documentation

Suitstrap's documentation, included in this repo in the root directory, is built with Jekyll and publicly hosted on GitHub Pages at http://suitstrap.maartenvanhoof.be. The docs may also be run locally.

Running documentation locally

If necessary, install Jekyll (requires v2.3.x).

Windows users: Read this unofficial guide to get Jekyll up and running without problems.

Install the Ruby-based syntax highlighter, Rouge, with gem install rouge.
From the root /suitstrap directory, run jekyll serve in the command line.
Open http://localhost:9001 in your browser, and voilà.

Learn more about using Jekyll by reading its documentation.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at http://editorconfig.org.

Community

At this moment it's a one man, after hour job. You can always contact me via Twitter

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, Suitstrap is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we'll adhere to those rules whenever possible.

Creators

Maarten Van Hoof

pixeo / suitstrap