piotrmurach/tty-markdown

TTY::Markdown
=============

**tty-markdown** converts markdown document into a terminal friendly output.

## Examples

### Nested list items

- Item 1
  - Item 2
  - Item 3
    - Item 4
- Item 5

### Definition lists

**Item 1**
: This is the description for Item 1

**Item 2**
: This is the description for Item 2
: This is another description for Item 2

### Quote

> Blockquotes are very handy in email to emulate reply text.
> This line is part of the same quote.
> *Oh*, you can put **Markdown** into a blockquote.

### Codeblock

```ruby
class Greeter
  def hello(name)
    puts "Hello #{name}"
  end
end
```

### Table

| Tables   |      Are      |  Cool |
|----------|:-------------:|------:|
| col 1 is | left-aligned  | $1600 |
| col 2 is | centered      | $12   |
| col 3 is | right-aligned | $1    |

### Maths

$$5+5$$

### Horizontal line

***

### Links

An [inline-style link](https://ttytoolkit.org)

An [inline-style link with title](https://ttytoolkit.org "TTY Toolkit Homepage")