https://github.com/chunqiuyiyu/qov

The terminal presentation tool.
https://github.com/chunqiuyiyu/qov

ascii cli presentation-slides terminal

Last synced: about 1 year ago
JSON representation

The terminal presentation tool.

• Host: GitHub
• URL: https://github.com/chunqiuyiyu/qov
• Owner: chunqiuyiyu
• License: mit
• Created: 2018-11-17T15:58:24.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-03-29T15:38:34.000Z (over 4 years ago)
• Last Synced: 2025-06-28T20:23:18.374Z (about 1 year ago)
• Topics: ascii, cli, presentation-slides, terminal
• Language: JavaScript
• Homepage:
• Size: 225 KB
• Stars: 154
• Watchers: 3
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# Qov · [![Build Status](https://img.shields.io/travis/chunqiuyiyu/qov.svg?style=flat-square)](https://travis-ci.org/chunqiuyiyu/qov) [![npm](https://img.shields.io/npm/v/qov.svg?style=flat-square)](https://www.npmjs.com/package/qov) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/chunqiuyiyu/qov/blob/master/LICENSE)

> The terminal presentation tool.

![preivew](./preview.gif)

## Features

* No third-party dependencies

* Tagged template literals

* Styled characters

* Fragments support

* Customized keyBinding

* Auto-sliding

* Easy to work with other libraries

## Getting started

```shell

npm install qov

```

Prepare texts for rendering slides.

```js

const Qov = require('qov')

const qov = new Qov()

qov.section`Section One`            

qov.section`Section Two`           

// Expression interpolation

qov.section`Section ${() => 'Three'}` 

// Render slides

qov.render()

```

Check [demo](./demo/index.js) for more details.

## APIs

### Constructor

```js

const qov = new Qov({ step?, keymap? })

```

step: milliseconds between auto-sliding, default is 2000.

keymap: customize keyBindings by yourself, defalut keymap is [here](./lib/keymap.js).

### Styles

```js

qov.styles.(str)

```

Style: style name, possiable value is blod, faint, italic, underline, slowBlink, rapidBlink, reverse or crossedOut.

str: characters which you want to render.

### Colors

Use `paint()` functon to render characters with color and backgroundColor.

```js

qov.colors.<Color>(str, isBg?)

qov.colors.paint(bgColor, fgColor, str)

```

Color, bgColor, fgColor: color name(black, red, green, yellow, blue, magenta, cyan, white).

isBg: render characters by backgroundColor or not, default is false.

## Much more

via [Tagged template literals](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals#Tagged_templates), you can use other JS packages in Qov slides.**The only requirement is that package needs to return a string.**

## License

[MIT](./LICENSE)