Skip to content

πŸ–οΈ Terminal styling done light and fast.

License

Notifications You must be signed in to change notification settings

crayon-js/crayon

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.

Crayon 4.x follows conventional commits.
If your pull request's code could introduce understandability trouble, please add comments to it.

πŸ“ Licensing

This project is available under MIT License conditions.