https://github.com/crayon-js/crayon

🖍️ Terminal styling done light and fast.
https://github.com/crayon-js/crayon

256-colors ansi ansi-escape-codes cmd coloring console deno javascript js node node-js nodejs npm package rgb styling terminal ts typescript

Last synced: 4 days ago
JSON representation

🖍️ Terminal styling done light and fast.

• Host: GitHub
• URL: https://github.com/crayon-js/crayon
• Owner: crayon-js
• License: mit
• Created: 2021-04-06T12:49:50.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-08-26T18:37:05.000Z (4 months ago)
• Last Synced: 2024-12-13T23:55:49.076Z (8 days ago)
• Topics: 256-colors, ansi, ansi-escape-codes, cmd, coloring, console, deno, javascript, js, node, node-js, nodejs, npm, package, rgb, styling, terminal, ts, typescript
• Language: TypeScript
• Homepage:
• Size: 346 KB
• Stars: 47
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        


[![deno github workflow](https://github.com/crayon-js/crayon/actions/workflows/deno.yml/badge.svg)](https://github.com/crayon-js/crayon/actions/workflows/deno.yml)



🖍️ 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

```ts

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](https://www.conventionalcommits.org/en/v1.0.0/).\

If your pull request's code could introduce understandability trouble, please add comments to it.

## 📝 Licensing

This project is available under **MIT** License conditions.