1 | # JADE-Bootstrap
|
2 | [Bootstrap](http://getbootstrap.com) framework written completely using mixins in [JADE](http://jade-lang.com)
|
3 |
|
4 | [![Build Status](https://travis-ci.org/rajasegar/JADE-Bootstrap.svg?branch=master)](https://travis-ci.org/rajasegar/JADE-Bootstrap)
|
5 | [![npm](https://img.shields.io/npm/dm/jade-bootstrap.svg)](https://www.npmjs.com/package/jade-bootstrap)
|
6 | [![npm version](http://img.shields.io/npm/v/jade-bootstrap.svg?style=flat)](https://npmjs.org/package/jade-bootstrap "View this project on npm")
|
7 | [![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
|
8 |
|
9 | ##Website
|
10 | [JADE-Bootstrap](http://rajasegar.github.io/JADE-Bootstrap/)
|
11 |
|
12 | ##Documentation
|
13 | [Documentation](http://rajasegar.github.io/JADE-Bootstrap/)
|
14 |
|
15 | ##Wiki
|
16 | Go to [wiki](http://rajasegar.github.io/JADE-Bootstrap/) page
|
17 |
|
18 | ## Quickstart
|
19 | Several quick start options are available:
|
20 | * [Download the latest release] (https://github.com/rajasegar/JADE-Bootstrap/archive/master.zip)
|
21 | * Clone the repo: `git clone https://github.com/rajasegar/JADE-Bootstrap.git`.
|
22 | * Install with [Bower](http://bower.io/): `bower install jade-bootstrap`.
|
23 | * Install with [npm](https://www.npmjs.com/): `npm install jade-bootstrap`.
|
24 |
|
25 | The quickest way to get started for NodeJS applications is with this [boilerplate](https://github.com/rajasegar/jadebootstrap-seed)
|
26 |
|
27 | ### What's included
|
28 |
|
29 | Within the download you'll find the following directories and files, logically grouping common mixins. You'll see something like this:
|
30 |
|
31 | ```
|
32 | bootstrap.jade
|
33 | ├── components/
|
34 | │ ├── accordion.jade
|
35 | │ ├── alerts.jade
|
36 | │ ├── carousel.jade
|
37 | │ ├── dropdowns.jade
|
38 | │ ├── forms.jade
|
39 | │ ├── icons.jade
|
40 | │ ├── labels.jade
|
41 | │ ├── list-groups.jade
|
42 | │ ├── modal.jade
|
43 | │ ├── navbar.jade
|
44 | │ ├── navs.jade
|
45 | │ ├── panels.jade
|
46 | │ ├── progress-bars.jade
|
47 | │ ├── tables.jade
|
48 | │ ├── tabs.jade
|
49 | │ ├── toggle.jade
|
50 | │ └── tooltips.jade
|
51 | └── layouts/
|
52 | ├── blog.jade
|
53 | ├── carousel.jade
|
54 | ├── cover.jade
|
55 | ├── dashboard.jade
|
56 | ├── jumbotron.jade
|
57 | ├── jumbotron-narrow.jade
|
58 | ├── justified-nav.jade
|
59 | ├── navbar.jade
|
60 | ├── navbar_fixed.jade
|
61 | ├── navbar_static.jade
|
62 | ├── non-responsive.jade
|
63 | ├── offcanvas.jade
|
64 | ├── sign-in.jade
|
65 | ├── starter.jade
|
66 | ├── sticky-footer.jade
|
67 | ├── sticky-footer-navbar.jade
|
68 | └── theme-template.jade
|
69 |
|
70 | ```
|
71 |
|
72 |
|
73 | ## Features
|
74 |
|
75 | * Bootstrap set as the default UI framework
|
76 | * JADE set as the default Template engine
|
77 | * Focus on high performance
|
78 | * Super-speed development using JADE mixins
|
79 | * Some widely used sample layouts to start with.
|