font-ascii

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 13 Open GitHub ↗

Print a magical phrase using node!

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![fontascii](http://i.imgur.com/xXBkyTE.png)

# Font Ascii

An Awesome Logger That will log an ASCII phrase for you!
Import and use it in your code, or just use the CLI (command line interface)

![howtouse](https://thumbs.gfycat.com/OrnateAcrobaticEchidna-size_restricted.gif)

# How to use

Easy! Just type this in your project

```bash
npm i --save font-ascii
```

```bash
npm i -g font-ascii
```

## Using - CLI

If you installed globally, just:
`font-ascii 'Hello World'`

Otherwise, use it like:
`$(npm bin)/font-ascii 'Hello World'`

## Using - Importing

You can import it on your project like this:

```javascript
//ES6 Flavour
import formPhrase from 'font-ascii';

//Old fashioned
var formPhrase = require('font-ascii').default;
```

## Using

```javascript
formPhrase('Awesome Phrase');
```

# Configuration

## Typeface

Per default, it will use a random font, but you can choose one of the following:
(if there is a typo, it will fallback to a random font!)

- Acrobatic
- Alpha
- Avatar
- Big
- BigMoneyne
- BigMoneynw
- BigMoneyse
- BigMoneysw
- Blocks
- Bulbhead
- Cards
- Chiseled
- Crawford2
- Crazy
- DancingFont
- Diagonal3d
- Doh
- Doom
- EftiWall
- Epic
- Firefontk
- FireFonts
- FlowerPower
- FunFace
- FunFaces
- Ghost
- Graceful
- Graffiti
- Impossible
- Isometric1
- Isometric2
- Isometric3
- Isometric4
- JSBracketLetters
- LilDevil
- Merlin1
- Modular
- Ogre
- PatorjkCheese
- PatorjkHeX
- Rectangles
- Slant
- SlantRelief
- Small
- SmallIsometric1
- SmallSlant
- Soft
- Standard
- StarWars
- SubZero
- SwampLand
- Sweet
- Train
- Twisted
- Varsity
- WetLetts

And pass it like:

```javascript
formPhrase('Hello', { typeface: 'Diagonal3d' });
```

```bash
font-ascii Hello -t Diagonal3d
```

```bash
font-ascii Hello --typeface Diagonal3d
```

## Color

You can choose one of these defaults color. Otherwise it's always random:

- 'red'
- 'green'
- 'yellow'
- 'blue'
- 'magenta'
- 'cyan'
- 'white'
- 'gray'
- 'grey'

```javascript
formPhrase('Hello', { typeface: 'Diagonal3d', color: 'red' });
```

```bash
font-ascii Hello -c red
```

```bash
font-ascii Hello --color red
```

## Object

```javascript
const config = {
  typeface: STRING,
  color: STRING,
  verbose: BOOLEAN,
};
```

## Contributing

It's a random idea I had and done in my free time, so probably it contains a lot of bugs, but feel free to open a PR with any optimization! Anything would be awesome!

And [ISSUES](https://github.com/sauloxd/font-ascii/issues), open them if you find anything wrong.

LOTS AND LOTS of kudos to this guys, and his awesome site:

[Patorjk](http://patorjk.com/software/taag/#p=display&f=Alpha&t=A)

There you'll find shit ton of other fonts.

### Development

First clone the repo:

```bash
git clone git@github.com:Sauloxd/font-ascii.git
```

Enter the cloned repo and install dependencies! Make sure you are using yarn (since its my package manager of choice) - [How to install yarn](https://yarnpkg.com/lang/en/docs/install/#mac-stable)

```bash
cd font-ascii
yarn install
```

Just call this command!

```bash
yarn start hello
```

And it will call the development version of this project!

There is no currently easy way to test the compiled version, so we must believe the @babel power :)

font-ascii

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README