1.0.1 • Published 6 years ago

boxy-font v1.0.1

Weekly downloads
2
License
MIT
Repository
github
Last release
6 years ago
┌──────┐ ┌───────┐┌───┬───┐┌───┬───┐     ┌───────┐┌───────┐┌────┬──┐┌───────┐
│   ─  └┐│   │   │├─     ─┤│       │     │    ───┤│   │   ││    │  ││       │
│   ──  ││       ││   │   │├──     │     │     ┌─┘│       ││  │    │└─┐   ┌─┘
└───────┘└───────┘└───┴───┘└───────┘     └─────┘  └───────┘└──┴────┘  └───┘

Overview

Boxy Font is a fancy font with square characters. It can be used in any monospaced environment. For example, you can create a terminal banner, print it in the browser developer console, or use it as a heading in your README.

Install

yarn add boxy-font

How to use

boxy(value)

Converts an input string into string of boxy characters.

const { boxy } = require('boxy-font');

const boxyfied = boxy('hello world!');

Arguments

  • value (string): The string to convert.

Returns

  • (string): The converted string.

generateCharsTable()

Generates the table of all supported characters.

const { generateCharsTable } = require('boxy-font/utils');

console.log(generateCharsTable());

Returns

  • (string): The table as a multi-line string.