sevenecks/markdown-terminal

convert markdown to terminal output in php

0.0.1 2018-09-12 19:06 UTC

Requires

• php: >=7.0
• cebe/markdown: ~1.2.0
• sevenecks/ansi: ^1.0
• sevenecks/string-utils: ^0.0.15

Requires (Dev)

• squizlabs/php_codesniffer: ^3.3

MIT

• Brendan Butts

• php
• cli
• markdown
• console
• command line
• shell
• string
• formatting
• pretty printer

README

This project is an extension of Markdown that adds the ability to convert markdown to terminal output instead of HTML.

This is just a little hobby project I wrote to support a terminal based markdown note taker in PHP. The conversion does it's best, but it's by no means complete or bug free. I'll improve it as my needs demand but use this at your own risk, and don't expect it to look super pretty at this point :)

You can use the setConfig function to set various config options for colorizing the output.

Installation

Via Composer

composer require sevenecks/markdown-terminal

Example Usage

<?php
// you must run this from the /example directory
//
require '../vendor/autoload.php';

$markdown = <<<EOT
# Headline 1
## Headline 2
### Headline 3
#### Headline 4
##### Headline 5
###### Headline 6

\```
protected function renderStrong($block)
{
    return \$this->colorize->bold(\$this->renderAbsy($block[1]));
}
\```

* One
* Two
* Five
    1. test
    2. test2

1. Four
2. Five
3. Six
    * Test
    * Test 2
    
* One
* Two
    * Four
        1. test
        2. test
            * test

> this is a test this is a test this is a test this is a test           this is a test this is a test this is a test this is a test this is a test this is a test this is a test this is a test this is a test this is a test this is a test 
> test
> this is a test
> another test

>> test quote in quote, which doesn't currently work.

this is a **strong** text

this is some _emphasis_.

[I'm an inline-style link](https://www.github.com/sevenecks)

[I'm a relative reference to a repository file](../blob/master/LICENSE)

Inline-style: [Seven Ecks Git Hub Alt Text](http://www.github.com/sevenecks "Sevenecks GitHub Title")

[another example]: https://github.com/sevenecks "another example"

~~Strike Through~~

EOT;
$parser = new SevenEcks\Markdown\MarkdownTerminal;
echo $parser->parse($markdown);

Known Issues

1. quoted quotes do not work
2. specifying a language after three backticks (`) does not work and will format weirdly.
3. Every now and then wonkiness happens with list items
4. strikethrough won't work on all terminal emulators

Change Log

Please see Change Log for more information.

License

The MIT License (MIT). Please see License File for more information.