Git Product home page Git Product logo

css-inline-images's Introduction

css-inline-images

Simple node module for inlining images as base64 strings in CSS.

##Installation Install with NPM like any other package

npm install css-inline-images

##Usage Append ?embed to the urls of the images that you want inlined

var cssInlineImages = require('css-inline-images'),
    inputCss,
    outputCss;

inputCss = [
    '.leave-me-alone {',
        'background-image: url(file.gif);',
    '}',

    '.embed-me {',
        'background-image: url(file.gif?embed);',
    '}'
].join('');

outputCss = cssInlineImages(inputCss, {
    webRoot: 'web',
    path: 'otherImages'
});

The module will search for url() declarations in your CSS code so its use is not limited to background images.

##Options

  • webRoot The web root of your web project. This property will be used as a start point for all file paths. This is enough for absolute urls (e.g. url(/images/file.gif?embed))

  • path Used in addition to webRoot to determine the paths for relative urls (e.g. url(images/file.gif?embed))

###Example With these options the following paths will be used to locate the images in the filesystem

{
    webRoot: 'web',
    path: 'otherImages'
}
  • url(/images/file.gif?embed) => web/images/file.gif
  • url(file.gif?embed) => web/otherImages/file.gif

css-inline-images's People

Contributors

sjorsrijsdam avatar mattisfrommars avatar

Watchers

 avatar

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.