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'

to be continued....

More Information

• Introduction screencast

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:

• TJ Holowaychuk (Original Creator)
• Sean Lang (Current Maintainer)
• Isaac Johnston
• Everyone Else

License

(The MIT License)

Copyright (c) 2011 TJ Holowaychuk <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.