hiting

Highlight-text printer for console.

Usage no npm install needed!

<script type="module">
  import hiting from 'https://cdn.skypack.dev/hiting';
</script>

README

hiting

Highlight-text printer for console.

If links in this document not avaiable, please access README on GitHub directly.

Description

This tool will automatically parse plain text and print colorful and easy-to-read text in console. Users are allowed to supply a favorite printing style. However, that is all!

Table of Contents

Links

Get Started

CLI mode:

# Globally install.
npm install -g hiting
hiting <path-of-txt-file>

API mode:

const hiting = require('hiting');

// Parse and print plain text in "tips" style.
hiting(text, 'tips');

API

  • hiting(string|Buffer text, string style)
    See section Styles for available values of parameter style.

Styles

In current version, only one style is avaiable. More styles will be supplied in later versions. The realization of existing styles may be changed in subsequent versions. So, DO NOT REARRANGE THE OUTPUT OF hiting. Just read it.

Following colorful texts in black background are generated by hiting.

  • tips
    tips
    Generated by version 0.0.1