https://github.com/phppkg/cli-markdown

Render colored Markdown contents on console terminal
https://github.com/phppkg/cli-markdown

cli markdown

Last synced: 4 days ago
JSON representation

Render colored Markdown contents on console terminal

• Host: GitHub
• URL: https://github.com/phppkg/cli-markdown
• Owner: phppkg
• License: mit
• Created: 2021-08-12T12:10:22.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-03-12T03:23:18.000Z (8 months ago)
• Last Synced: 2024-10-27T21:17:46.797Z (14 days ago)
• Topics: cli, markdown
• Language: PHP
• Homepage:
• Size: 85 KB
• Stars: 9
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# CLI-Markdown

[![License](https://img.shields.io/packagist/l/phppkg/cli-markdown.svg?style=flat-square)](LICENSE)

[![Php Version](https://img.shields.io/badge/php-%3E=8.0.0-brightgreen.svg?maxAge=2592000)](https://packagist.org/packages/phppkg/cli-markdown)

[![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/phppkg/cli-markdown)](https://github.com/phppkg/cli-markdown)

[![Actions Status](https://github.com/phppkg/cli-markdown/workflows/Unit-Tests/badge.svg)](https://github.com/phppkg/cli-markdown/actions)

Render colored markdown contents on console terminal

**Preview**

> run demo by `php example/demo.php`

![demo](example/demo.png)

## Features

- support auto render color on terminal

- support custom set cli color tags

## Install

**composer**

```bash

composer require phppkg/cli-markdown

```

## Usage

quick usage:

```php

render($contents);

echo $rendered;

```

## Base on

package | description

---------|--------------

`cebe/markdown` | parse markdown contents

`toolkit/cli-utils` | provide cli color render

## License

[MIT](LICENSE)