Skip to main content

๐Ÿ–๏ธ Crayon.js

๐Ÿ“š About

Crayon is terminal styling module written in Typescript.

From the ground up its goals is to be fast, relatively lightweight and modular.

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

  • โšก High performance
  • ๐Ÿ“ฆ No dependencies
  • ๐Ÿง‘โ€๐Ÿ’ป Good code quality
  • ๐Ÿ—‘๏ธ Modularity (no unnecessary code)
  • ๐Ÿง Familiar API (chalk-like)
  • ๐Ÿฆ„ Automatic color fallbacking
    • ๐ŸŽจ Automatic color detection via color_support extension
  • ๐Ÿ”— Supported nesting & chaining
  • ๐Ÿชข Not extending String.prototype
  • ๐ŸŒˆ 24bit (16.7m -ย truecolor) and 8bit (256 - highcolor) color support

๐Ÿค 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 3.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.