Skip to content
Stylus mixins, utilities, components, and gradient image generation
CSS JavaScript HTML
Branch: master
Clone or download

Latest commit

Latest commit 5ba7db7 Mar 9, 2018

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
iconic
lib fix border-radius prop output Jun 11, 2015
test update testcases Jun 11, 2015
.editorconfig add an editorconfig Jun 25, 2014
.gitignore ignore *.swp files Aug 1, 2012
.npmignore gitignore May 16, 2011
.travis.yml
LICENSE update copyright year Feb 4, 2014
Readme.md Update build badge url Mar 9, 2018
index.styl closes #206 Jul 29, 2013
package.json Release 1.1.2 Aug 5, 2016

Readme.md

Build Status

Nib

Stylus mixins, utilities, components, and gradient image generation. Don't forget to check out the documentation.

Installation

$ npm install nib

If the image generation features of Nib are desired, such as generating the linear gradient images, install node-canvas:

$ npm install canvas

JavaScript API

Below is an example of how to utilize nib and stylus with the connect framework (or express).

var connect = require('connect')
  , stylus = require('stylus')
  , nib = require('nib');

var server = connect();

function compile(str, path) {
  return stylus(str)
	.set('filename', path)
	.set('compress', true)
	.use(nib());
}

server.use(stylus.middleware({
	src: __dirname
  , compile: compile
}));

Stylus API

To gain access to everything nib has to offer, simply add:

@import 'nib'

Or you may also pick and choose based on the directory structure in ./lib, for example:

@import 'nib/gradients'
@import 'nib/overflow'
@import 'nib/normalize'

To be continued...

More Information

Testing

You will first need to install the dependencies:

   $ npm install -d

Run the automated test cases:

   $ npm test

For visual testing run the test server:

   $ npm run-script test-server

Then visit localhost:3000 in your browser.

Contributors

I would love more contributors. And if you have helped out, you are awesome! I want to give a huge thanks to these people:

You can’t perform that action at this time.