Awesome
<!-- TODO: Add coverage badge --> <img align="center" src="https://github.com/crayon-js/crayon/raw/main/docs/logo.svg" alt="Crayon logo: Totally not creppy humanized crayon staring and waving hand at you" height="256px" width="100%"> <h1 align="center">ποΈ Crayon</h1>π 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
- π¨ Automatic color detection via
- π 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!"));
<!-- TODO: Change this after restructuring repos
## 𧩠Extensions
To add new functionality to Crayon you can use ready or create your own extensions.\
Crayon's extensions are stored in [src/extensions](./src/extensions/)
-->
π€ 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.