Giter VIP home page Giter VIP logo

grunt-include-bootstrap's Introduction

grunt-include-bootstrap

Use Bootstrap the right way. IAvoid onion layered CSS by building fresh each time, customized for your styles.

Getting Started

This plugin requires Grunt ~0.4.1

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-include-bootstrap --save-dev

One the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-include-bootstrap');

The "include_bootstrap" task

Overview

In your project's Gruntfile, add a section named include_bootstrap to the data object passed into grunt.initConfig().

grunt.initConfig({
  include_bootstrap: {
    options: {
      // All options are passed on to the grunt-contrib-less task
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    }
  }
});

Options

See the grunt-contrib-less project for the available options.

Recommended Usage

I'd recommend creating a manifest.less file which @imports all your other LESS files. You can import any Bootstrap LESS files from any of your files. For example:

grunt.initConfig({
  include_bootstrap: {
    development: {
      options: {
        sourceMap: true,
        dumpLineNumbers: 'comments',
        relativeUrls: true
      },
      files: {
        'dest/styles.css': 'less/manifest.less',
      },
    },
    production: {
      options: {
        cleancss: true,
        compress: true,
        relativeUrls: true
      },
      files: {
        'dest/styles.css': 'less/manifest.less',
      },
    }
  }
});

And in ./less/manifest.less

// Import Bootstrap source
@import 'bootstrap';    // This will import the entire Bootstrap base
@import 'responsive';   // Bootstrap responsiveness is not included by default in the file above

// Import your LESS files here
@import 'variables';    // Will import ./less/variables.less
@import 'signup';

Keep in mind that LESS variables are retroactive, so you an override a Bootstrap variable in your LESS files, and it will change throughout the Bootstrap core.

LESS Options

All task options are passed directly on to the grunt-contrib-less task.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style.

Release History

April 29, 2013 - v0.1.1 - initial release

grunt-include-bootstrap's People

Contributors

davewasmer avatar mlunoe avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

grunt-include-bootstrap's Issues

bootstrap 3 support

How can I get this to work w/ Bootstrap 3?

Ideally, I would like to include Bootstrap files separately and have this task point to the bootstrap location and compile from there. That way we don't have to update this module everytime there are minor updates in bootstrap.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.