Skip to content

crayon-js/crayon

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

deno github workflow

Crayon logo: Totally not creppy humanized crayon staring and waving hand at you

๐Ÿ–๏ธ Crayon

๐Ÿ“š About

Crayon is a terminal styling module written in TypeScript.
From the ground up its goals are to be fast, relatively lightweight and modular.

๐Ÿ–๏ธ Crayon.js offers:

  • โšก Great performance
  • ๐Ÿ“ฆ No dependencies
  • ๐Ÿ—‘๏ธ Modularity (use what you need)
  • ๐Ÿง Familiar API (chalk-like)
  • ๐Ÿฆ„ Built-in color fallbacking
    • ๐ŸŽจ Automatic color detection via @crayon/color-support extension package
  • ๐Ÿ”— Support for nesting & chaining styles
  • ๐Ÿชข Not extending String.prototype
  • ๐ŸŒˆ 24bit (16.7mln -ย truecolor) and 8bit (256 - highcolor) color support

โš™๏ธ Usage

import crayon from "@crayon/crayon";

console.log(crayon.red("its red!"));

๐Ÿค Contributing

Crayon is open for any contributions.
If you feel like you can enhance this project - please open an issue and/or pull request.
Code should be well document and easy to follow what's going on.

Since the start of development on Crayon 4.0 this project follows conventional commits spec.
If your pull request's code could introduce understandability trouble, please add comments to it.

๐Ÿ“ Licensing

This project is available under MIT License conditions.