crayon

KO | EN

gitlite — search

#javascript #hacktoberfest #ai #llm #go #rust #linux #macos #nodejs #windows #awesome #cli #awesome-list #pytorch

(★ 113)

🖍 Paint your console from .NET

crayon Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![build](https://ci.appveyor.com/api/projects/status/8dnbd2u8t737lm21/branch/master?svg=true)](https://ci.appveyor.com/project/riezebosch/crayon/branch/master)
[![nuget](https://img.shields.io/nuget/v/Crayon.svg)](https://www.nuget.org/packages/Crayon/)

# 🖍 Crayon
An easy peasy tiny library for coloring console output in inline strings using ANSI escape codes.

# V2

The API has changed to support background colors. 
I dropped the extension methods on string and opted for the using static directive instead.
All methods now have an overload for direct input so you no longer have to end with a `Text()` invocation.

## Examples

```c#
using static Crayon.Output;

Console.WriteLine(Green($"green {Red($"{Bold("bold")} red")} green"));
Console.WriteLine(Bright.Blue($"Bright {Green("and normal green")}"));
Console.WriteLine(Bold().Green().Text($"starting green {Red("then red")} must be green again"));
```

![screenshot](https://raw.githubusercontent.com/riezebosch/crayon/master/screenshot.png)

## Colors

```c#
Black()
Red()
Green()
Yellow()
Blue()
Magenta()
Cyan()
White()
```

```c#
Rgb(r, g, b)
```

```c#
Background.Blue()
Bright.Blue()
```

## Decorations

```c#
Bold()
Dim()
Underline()
Reversed()
```

## Text

```c#
Blue().Underline().Text("input")
Blue().Underline("input")
```

All colors and decorations have an overload with direct input and terminating the formatter.

## Rainbows 🌈

Thanks to [DevinR528](https://github.com/devinRagotzy) we now have rainbows!

```c#
var rainbow = new Rainbow(0.5);
for(var i = 0; i < 15; i++)
{
    Console.WriteLine(rainbow.Next().Bold().Text("rainbow"));
}
```

## How compatible is it?

It works fine on everything except for older Windows versions.

## Credits

My journey for using ANSI codes in C# first brought me here: https://www.jerriepelser.com/blog/using-ansi-color-codes-in-net-console-apps/

The ANSI coloring details was inspired by this blog post: http://www.lihaoyi.com/post/BuildyourownCommandLinewithANSIescapecodes.html

The code for enabling ANSI colors feature on Windows was borrowed from this issue: https://github.com/Microsoft/WSL/issues/1873

No greater compliment than someone [taking your work for inspiration](https://github.com/silkfire/Pastel). In return I peaked into his code for the RGB support!

crayon

crayon Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

crayon

crayon Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README