colorate
Version:
A simple and lightweight terminal stylizer.
57 lines (40 loc) ⢠2.08 kB
Markdown
# Colorate
A simple and lightweight terminal stylizer.
<sub><a href="https://github.com/ivodolenc/colorate">Repository</a> | <a href="https://www.npmjs.com/package/colorate">Package</a> | <a href="https://github.com/ivodolenc/colorate/releases">Releases</a> | <a href="https://github.com/ivodolenc/colorate/discussions">Discussions</a></sub>
```sh
npm i colorate
```
## Features
- TypeScript friendly
- Fully tree-shakeable
- No dependencies
## Usage
```js
import { cl, bold, lime, n } from 'colorate'
cl(bold(lime('colorate ')) + 'š¬ Package info...', n)
```
## API
| Text Colors | Background Colors | Text Styles | Console Aliases |
| ----------- | ----------------- | ------------- | --------------- |
| `amber()` | `bgAmber()` | `bold()` | `cl()` |
| `black()` | `bgBlack()` | `crossout()` | `cw()` |
| `blue()` | `bgBlue()` | `darken()` | `ce()` |
| `cyan()` | `bgCyan()` | `hidden()` | `n` |
| `gray()` | `bgGray()` | `invert()` | |
| `green()` | `bgGreen()` | `italic()` | |
| `indigo()` | `bgIndigo()` | `reset()` | |
| `lime()` | `bgLime()` | `underline()` | |
| `magenta()` | `bgMagenta()` | | |
| `pink()` | `bgPink()` | | |
| `red()` | `bgRed()` | | |
| `rose()` | `bgRose()` | | |
| `silver()` | `bgSilver()` | | |
| `sky()` | `bgSky()` | | |
| `white()` | `bgWhite()` | | |
| `yellow()` | `bgYellow()` | | |
## Community
Feel free to use the official [discussions](https://github.com/ivodolenc/colorate/discussions) for any additional questions.
## License
Developed in šš· Croatia
Released under the [MIT](LICENSE.txt) license.
Ā© Ivo Dolenc