fur

Front end design tool.

fur

Front end design tool.
Generate images and stylesheets.

Prerequisites
Install
Usage
- CLI Help
- Available Commands
Programmatic API
Examples
Documents
Donation
License
Links

Prerequisites

fur depends on node-canvas, and it requires some setting up.
For more detail, see the node-canvas install guide.

Install

Install fur via npm:

$ sudo npm install fur -g

Usage

CLI Help

$ fur -h
 
  Usage: fur [options] [command]
 
  Commands:
 
    badge [options] <filename> Generate a badge.
    favicon [options] <filename> Generate a favicon.
    ico <src> <dest>       Convert a png file to ico file.
    logo [options]         Generate a logo.
    resize [options] <src> <dest> Resize a image.
    subset <letters> <src> <dest> Generate font subset.
    woff <src> <dest>      Convert a ttf file to woff.
 
  Options:
 
    -h, --help     output usage information
    -V, --version  output the version number

Available Commands

Programmatic API

All fur commands are exports in programmatic API, too. They are exported in "commands" namespace of the fur module.

For example,

#!/usr/bin/env node
var fur = require('fur');
fur.commands.favicon('dist/my-favicon.png', {
    text:'JJ',
    colorTheme: 'e'
}, function(err){
});

is equivalant to:

#!/bin/bash 
fur favicon dist/my-favicon.png --text JJ --color--theme 'e'

Note that option args are camel-cased in programmatic API. ("--color-theme" would be "colorTheme").

Form more detail, see the API Document

Examples

Badge Examples

Output	Command
	`$ fur badge apeman-badge-default.png --style default --color-theme bb --texts powered by , apeman`
	`$ fur badge apeman-badge-flat.png --style flat --color-theme bb --texts powered by , apeman`

Favicon Examples

Output	Command
	`$ fur favicon tick-tack-favicon.png --text tt --text-left -1 --text-top -4 --color-theme fo --font-theme bb --font-size 145`
	`$ fur favicon restful-viewer-favicon.png --text V --color-theme ht --font-theme x --font-size 130`
	`$ fur favicon fur-favicon.png --font-size 52 --text FUR --color-theme bb --font-theme by`
	`$ fur favicon pp-abstract-favicon.png --text a --color-theme a --font-theme e --font-size 130 --style circle --text-top -12 --text-left -7`
	`$ fur favicon pp-static-favicon.png --text s --color-theme gs --font-theme j --style bordered --text-top -12`
	`$ fur favicon xx-paperwork-favicon.png --text p --color-theme jj --font-theme l --style round --text-top -10`

Logo Examples

Output	Command
	`$ fur logo fur-logo.png --font-size 104 --text FUR --color-theme bb --font-theme by --height 256 --width 358.4`
	`$ fur logo tick-tack-logo.png --font-size 104 --text tick-tack --text-left -3 --color-theme fo --font-theme bb --height 256 --width 512`
	`$ fur logo restful-viewer-logo.png --font-size 104 --text Restful Viewer --color-theme ht --font-theme x --height 256 --width 691.2`
	`$ fur logo pp-abstract-logo.png --font-size 104 --text pp-abstract --color-theme a --font-theme e --height 256 --width 640`
	`$ fur logo pp-static-logo.png --font-size 104 --text pp-static --color-theme gs --font-theme j --height 256 --width 614.4`
	`$ fur logo xx-paperwork-logo.png --font-size 104 --text pp-static --text-top -10 --color-theme jj --font-theme l --height 256 --width 614.4`