Skip to content

foundation/foundation-sites

Repository files navigation

Gitter

Foundation is the most advanced responsive front-end framework in the world. Quickly go from prototype to production, building sites or apps that work on any kind of device with Foundation. Includes layout constructs, like a fully customizable, responsive grid, commonly used JavaScript plugins, and full A11Y support.

Requirements

Requires NodeJS to be installed on your machine. Works with 0.10, 0.12, and 4.1! Note that parts of our build process will break with NPM 3, due to the changes in how packages are installed.

The Sass is compiled using libsass, which requires the GCC to be installed on your machine. Windows users can install it through MinGW, and Mac users can install it through the Xcode Command-line Tools.

Setup

To get going with Foundation you can:

Documentation

Foundation uses Gulp and SuperCollider to generate its documentation pages. Documentation can also be run from your local computer:

View documentation locally

You'll want to clone the Foundation repo first and install all the dependencies. You can do this using the following commands:

git clone git@github.com:zurb/foundation-sites.git
cd foundation-sites
npm install

Then just run npm start and the documentation will be compiled. It will also launch an instance of BrowserSync and open a tab in your default browser. The file structure:

foundation/
├── dist/
│   └── ...
├── docs/
│   └── ...

Copyright (c) 2015 ZURB, inc.