Skip to content

stylus/nib

Folders and files

NameName
Last commit message
Last commit date

Latest commit

5e2651e · May 17, 2022
May 17, 2022
Dec 27, 2017
Jun 25, 2014
Nov 27, 2020
May 17, 2022
Jun 25, 2014
Nov 27, 2020
May 17, 2022
May 17, 2022
May 17, 2022
May 17, 2022
May 17, 2022
Jul 29, 2013
May 17, 2022
May 17, 2022

Repository files navigation

Nib npm npm build status

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: