Installation
There are many ways to install Foundation, but if you're just getting started, we have a few suggestions.
Install with Package Managers
Foundation is available on npm. The package includes all of the source Sass and JavaScript files, as well as compiled CSS and JavaScript, in uncompressed and compressed flavors.
Here's what comes in the package.
├─ scss Source Sass files. Use this folder as a load path in Sass.
├─ js Source JavaScript files. If you're using a build system, make sure `foundation.core.js` is loaded first.
└─ dist Compiled files:
├─ css * Compiled CSS files. Includes minified and unminified files.
├─ js * Concatenated JavaScript files. Includes minified and unminified files.
└─ plugins * Standalone JavaScript plugins.
Install with Foundation via CLI
Not a fan of GUIs? Foundation can easily be installed via the CLI. It can install the same template projects for you.
Basics Template Installation
git clone https://github.com/foundation/foundation-sites-template basic-project
cd basic-project
yarn install
yarn start
Experienced Template Installation
git clone https://github.com/foundation/foundation-zurb-template f6-project
cd f6-project
yarn install
yarn start
Basic template
Recommended for beginners
A basic template to begin to use Foundation. It includes:
- Foundation for Sites pre-configured.
-
Sass compilation
A tool to convert your SASS/SCSS files to CSS. -
Starter HTML file
A basic file to help you to use basic Foundation component (including the new XY grid !)
Experienced template
Recommended for experienced (or curious) users
A more advanced project including Foundation and a build process with:
- Handlebars HTML templates with Panini
- Sass compilation and prefixing
- JavaScript module bundling with webpack
- Built-in BrowserSync
- Production build with CSS, Javascript and Image compression
See advanced Template installations
Foundation 5 users: if you already have the Foundation 5 CLI on your machine, you will only be able to access one of the commands, depending on how your command line environment is configured.
To remove the Foundation 5 CLI, run gem uninstall foundation
. After testing the Foundation 6 CLI, if you want to remove it to go back to the old CLI, run npm uninstall foundation-cli --global
.
Windows users: make sure you've python v2.7 available in your node environment since it's required by the node-gyp tool. There are two way to achieve this
- Install the windows-build-tools (recommended) and make python afterwards accessible via
npm config set python "%USERPROFILE%\.windows-build-tools\python27\python.exe"
- Install python (not recommended) and add it to your system environment variables
The first way is recommended if you've not installed python v2.7 yet as it doesn't affect your machine outside the node environment. In case you've already installed python v2.7 you may of course skip both ways and start using foundationc-cli immediately.
Download
If you aren't into Sass, we have a starter template with compiled CSS and JavaScript, as well as a starting `index.html` file for you to hack on. Just unzip and get coding!
CDN Links
The folks at jsDelivr host the compressed Foundation CSS and JavaScript for us. Just drop one of these <script>
tags into your HTML and you're set:
<!-- Compressed CSS -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/foundation-sites@6.9.0/dist/css/foundation.min.css" crossorigin="anonymous">
<!-- Compressed JavaScript -->
<script src="https://cdn.jsdelivr.net/npm/foundation-sites@6.9.0/dist/js/foundation.min.js" crossorigin="anonymous"></script>
From Foundation 6.4, flex is enabled by default and only the new XY Grid is available. However, others CSS versions are available for backward compatibility and the most common usage cases. For others uses and advanced customization, we recommand to build Foundation with custom settings (see others installation methods).
<!-- foundation-float.min.css: Compressed CSS with legacy Float Grid -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/foundation-sites@6.9.0/dist/css/foundation-float.min.css" crossorigin="anonymous">
<!-- foundation-prototype.min.css: Compressed CSS with prototyping classes -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/foundation-sites@6.9.0/dist/css/foundation-prototype.min.css" crossorigin="anonymous">
<!-- foundation-rtl.min.css: Compressed CSS with right-to-left reading direction -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/foundation-sites@6.9.0/dist/css/foundation-rtl.min.css" crossorigin="anonymous">
HTML Starter Template
Start with this HTML template and adapt it to your needs. Be sure to include the .no-js
class on the html
tag of your template. Adding this class prevents flash of unstyled content for a number of foundation components.
<!doctype html>
<html class="no-js" lang="en">
<head>
<meta charset="utf-8" />
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Foundation Starter Template</title>
<link rel="stylesheet" href="css/foundation.css" />
</head>
<body>
<h1>Hello, world!</h1>
<script src="js/vendor/jquery.js"></script>
<script src="js/vendor/what-input.js"></script>
<script src="js/vendor/foundation.min.js"></script>
<script>
$(document).foundation();
</script>
</body>
</html>
Other Integrations
The Foundation community has helped us integrate the framework into Rails, WordPress, Django, and more. Head to our resources page to find even more ways to use Foundation.