Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/f1lt3r/ansi-to

😹 export ANSI to HTML, SVG, PNG, w/ iTerm2 color support
https://github.com/f1lt3r/ansi-to

ansi ansi-to ansi-to-html ansi-to-image chalk cli color console convert-ansi export export-ansi html node svg terminal

Last synced: 9 days ago
JSON representation

😹 export ANSI to HTML, SVG, PNG, w/ iTerm2 color support

Host: GitHub
URL: https://github.com/f1lt3r/ansi-to
Owner: F1LT3R
License: mit
Created: 2018-03-28T20:05:12.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2023-11-14T18:14:45.000Z (12 months ago)
Last Synced: 2024-04-25T19:00:39.026Z (6 months ago)
Topics: ansi, ansi-to, ansi-to-html, ansi-to-image, chalk, cli, color, console, convert-ansi, export, export-ansi, html, node, svg, terminal
Language: JavaScript
Homepage: https://f1lt3r.io
Size: 789 KB
Stars: 7
Watchers: 4
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # ANSI-to

> 😹  export ANSI color strings to various formats: HTML, SVG, PNG.

[![Build Status](https://travis-ci.org/F1LT3R/ansi-to.svg?branch=master)](https://travis-ci.org/F1LT3R/ansi-to)

[![Coverage Status](https://coveralls.io/repos/github/F1LT3R/ansi-to/badge.svg?branch=master)](https://coveralls.io/github/F1LT3R/ansi-to?branch=master)

[![NPM Version](https://img.shields.io/npm/v/ansi-to.svg)](https://www.npmjs.com/package/ansi-to)

[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)

ANSI-to takes a string of ANSI and converts it to various types of output. For example, this SVG:

[![Lead Image](ansi-to-svg-example.svg)](ansi-to-svg-example.svg)

## Support

Support the development of ANSI-to by [becoming a patreon](https://patreon.com/bePatron?u=9720216).



## Features

ANSI-to has the following plugins available:

- [SVG](https://github.com/F1LT3R/ansi-to-svg.git) - Export ANSI to Scalable Vector Graphics

- [PNG, JPG](https://github.com/F1LT3R/ansi-to-image) - Export ANSI to raster image (JPG, PNG)

- [HTML](https://github.com/F1LT3R/ansi-to-html) (coming soon)

Important: Do not use ANSI-to directly. Please use one of the above plugins.

**General Features**

- iTerm2 color support - [Base16 iTerm2 Color Schemes](https://github.com/martinlindhe/base16-iterm2)

- Use output in your `README.md` files

- Designed for use with [Chalk](https://github.com/chalk/chalk)

- Plugin architecture to build-your-own ANSI Parser

- Built-in default colors

- User can override colors

- Emoji support

- Powerline font support

## Why ANSI-to ?

ANSI-to is designed for use with ZTD development (Zero Technical Debt). ANSI-to provides a Markdown friendly way to include CLI output in your software documentation.