Code Monkey home page Code Monkey logo

inky.js's Introduction

Inky.js

alt text

About:

Inky.js is a small terminal styling library with big dreams.

it is still in early development and may be unstable on some devices

feature set:

Name Implemented release version
inky.<color>(<text>) true 0.0.1 +
inky.terminal true 0.0.2 +
String.<color>() false Cancelled
inky.hex partial (inky.terminal only) 0.1.0 +
inky.rgb partial (inky.terminal only) 0.1.0 +
TrueColor partial (inky.terminal only) 0.1.0 +
gradient partial (inky.terminal only) 0.1.1 +

Docs:

index:

intro
installation
usage
      console.log
      inky.terminal
Support List

intro:

Inky.js is an early stage competitor to the likes of chalk and colors

installation:

npm:

npm install inky.js

yarn:

yarn add inky.js

usage:

console.log:

console.log(inky.red.bold('Hello World'))

inky.terminal:

Inky.terminal is an extemded featureset of the default gloal conole, supporting all of the documented features of the console and extending them to include color features:

const terminal = new inky.terminal()
terminal.<color>.<style>()
//or you can use the console-log method
terminal.log(inky.<color>('Hello World'))

Support List

default colors (no styles)

Name terminal foreground background
Black yes yes yes
Blue yes yes yes
Cyan yes yes yes
Green yes yes yes
Magenta yes yes yes
Red yes yes yes
White yes yes yes
Yellow yes yes yes

default colors (styled)

Name style terminal foreground background
Black
bold yes yes yes
underscore yes yes yes
Blue
bold yes yes yes
underscore yes yes yes
Cyan
bold yes yes yes
underscore yes yes yes
Green
bold yes yes yes
underscore yes yes yes
Magenta
bold yes yes yes
underscore yes yes yes
Red
bold yes yes yes
underscore yes yes yes
White
bold yes yes yes
underscore yes yes yes
Yellow
bold yes yes yes
underscore yes yes yes
BONUS FEATURES Note
murica alternate colors of text to make an american themed output

all bonus features have full support in all output modes

found a problem? open an issue on our GitHub page

inky.js's People

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.