Vanilla Framework

Vanilla Framework is an extensible CSS framework, built using Sass and is designed to be used either directly or by using themes to extend or supplement its patterns.

Documentation | Join the mailing list

Using Vanilla
- Hotlinking
- Including Vanilla in your project via NPM
Developing Vanilla
Community

Using Vanilla

Hotlinking

You can link to the latest build to add directly into your markup like so, by replacing the x values with the version number you wish to link.

<link rel="stylesheet" href="https://assets.ubuntu.com/v1/vanilla-framework-version-x.x.x.min.css" />

Including Vanilla in your project via NPM

Pull down the latest version of Vanilla into your local node_modules folder and save it into your project's dependencies (package.json) as follows:

npm install --save-dev vanilla-framework

Now ensure that your SASS builder is including modules from node_modules. E.g. for Gulp:

// gulpfile.js
gulp.task('sass', function () {
  return gulp.src('[your-sass-directory]/**/*.scss').pipe(
    sass({
      includePaths: ['node_modules'],
    })
  );
});

Please note, that to provide the best browser support you should also include autoprefixer as a build step.

Then reference it from your own Sass files, with optional settings:

// Optionally override some settings
$color-brand: #ffffff;

// Import the theme
@import 'vanilla-framework/scss/vanilla';
@include vanilla;

// Add theme if applicable

If you don't want the whole framework, you can just @include specific parts - e.g. @include vf-b-forms.

Developing Vanilla

If you're looking to contribute to the Vanilla project itself, start here.

Community

Keep up to date with all new developments and upcoming changes with Vanilla.

Follow us on Twitter @vanillaframewrk
Read our latest blog posts at Ubuntu Blog

Code licensed LGPLv3 by Canonical Ltd

With ♥ from Canonical