Nifty Procrastination Machine

    vanilla-framework

    3.0.0-rc.1 • Public • Published

    vanilla Vanilla Framework

    CircleCI build status npm version Downloads devDependency Status Chat in #vanilla-framework on Freenode This project is using Percy.io for visual regression testing.

    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

    Table of contents

    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';
    @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.

    Code licensed LGPLv3 by Canonical Ltd

    With from Canonical

    Install

    npm i vanilla-framework@3.0.0-rc.1

    Version

    3.0.0-rc.1

    License

    LGPL-3.0

    Unpacked Size

    397 kB

    Total Files

    116

    Last publish

    Collaborators

    • anthonydillon
    • nottrobin
    • deadlight
    • ubuntudesign-jenkins
    • barrymcgee
    • calebellis
    • kwm14
    • bartaz