Ecosyste.ms: Awesome

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

https://github.com/sensiolabs/ansi-to-html

An ANSI to HTML5 converter
https://github.com/sensiolabs/ansi-to-html

Last synced: about 2 months ago
JSON representation

An ANSI to HTML5 converter

Lists

README 

        
ANSI to HTML5 Converter

=======================



This small library only does one thing: converting a text containing ANSI

codes to an HTML5 fragment:



```php

require_once __DIR__.'/vendor/autoload.php';



use SensioLabs\AnsiConverter\AnsiToHtmlConverter;



$converter = new AnsiToHtmlConverter();



$html = $converter->convert($ansi);

```



The `$ansi` variable should contain a text with ANSI codes, and `$html` will

contain the converted HTML5 version of it.



You can then output the HTML5 fragment in any HTML document:



```html+php



    

        


    



```



The converter supports different color themes:



```php

use SensioLabs\AnsiConverter\Theme\SolarizedTheme;



$theme = new SolarizedTheme();

$converter = new AnsiToHtmlConverter($theme);

```



By default, the colors are inlined into the HTML, but you can also use classes

by turning off style inlining:



```php

$converter = new AnsiToHtmlConverter($theme, false);

```



And the `asCss()` method of the theme object lets you retrieve the theme styles

as a CSS snippet:



```php

$styles = $theme->asCss();

```



which you can then use in your HTML document:



```html+php



    

        

            <?php echo $styles ?>



            .ansi_box { overflow: auto; padding: 10px 15px; font-family: monospace; }

        

    

    

        


    



```



Twig Integration

----------------



Register the extension:



```php

use SensioLabs\AnsiConverter\Bridge\Twig\AnsiExtension;



$twig->addExtension(AnsiExtension());

```



It's possible to use a custom ``AnsiToHtmlConverter``:



```php

use SensioLabs\AnsiConverter\Bridge\Twig\AnsiExtension;

use SensioLabs\AnsiConverter\Theme\SolarizedTheme;



$theme = new SolarizedTheme();

$converter = new AnsiToHtmlConverter($theme, false);



$twig->addExtension(new AnsiExtension($converter));

```



Then:



```jinja



    

        

            {# This is only need if the inline styling is disabled #}

            {{ ansi_css }}

        

    

    

        {{ some_ansi_code|ansi_to_html }}

    



```