Giter VIP home page Giter VIP logo

vanillabox's Introduction

Vanillabox Build Status

Overview

Vanillabox is a simple, modern Lightbox-like plugin for jQuery. You can easily setup your image gallery with this plugin.

See the official page for more information.

Why Vanillabox?

  • Simple design, no decoration. It focuses your content.
  • Suitable for modern browsers that include mobile ones. It works nicely whether or not to zoom a page.
  • Free for commercial use. It's licenced under the MIT License.

System Requirements

  • jQuery 1.7+
  • Chrome, Firefox, Safari, Opera, Internet Explorer 9+, iOS 6+ (Safari), Android 4.1.2+ (AOSP, Chrome)

How to Build Your Own Vanillabox

If you just want to use Vanillabox, get a compressed file from the official page. You may not need to perform the following steps.

First, these commands are required to setup a development environment:

Install gems and npm packages:

gem install sass -v '>=3.2'
npm install -g grunt-cli

You also need to install Closure Compiler to compress JS files:

git clone https://code.google.com/p/closure-compiler COMPILER_HOME
cd COMPILER_HOME
ant
export COMPILER_PATH=COMPILER_HOME

Next, clone the repository and get source files:

git clone https://github.com/cocopon/vanillabox VANILLA_HOME

Then move into the project directory, and run npm to install required npm packages:

cd VANILLA_HOME
npm install

All done! Now you can use grunt tasks for development.

grunt compile

Available Grunt Tasks

Command Description
grunt test Runs unit tests
grunt combine Generates an uncompressed JS file
grunt sass:theme Translates theme SCSS files into CSS files
grunt document Generates files for documents
grunt compile Compiles JS files
grunt package Generates a package archive

vanillabox's People

Contributors

cocopon avatar knickers avatar

Watchers

jadeye 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.