Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dar5hak/beautify-text-cli

Automated typographic quotation and punctuation marks
https://github.com/dar5hak/beautify-text-cli

beautify typography

Last synced: 6 days ago
JSON representation

Automated typographic quotation and punctuation marks

Host: GitHub
URL: https://github.com/dar5hak/beautify-text-cli
Owner: dar5hak
License: mit
Created: 2016-03-16T18:29:29.000Z (over 8 years ago)
Default Branch: main
Last Pushed: 2024-04-04T08:50:00.000Z (7 months ago)
Last Synced: 2024-10-22T06:28:37.558Z (14 days ago)
Topics: beautify, typography
Language: JavaScript
Size: 499 KB
Stars: 0
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # beautify-text-cli

> Automated typographic quotation and punctuation marks. CLI for [bevacqua/beautify-text](https://github.com/bevacqua/beautify-text).

[![Travis (.org)](https://img.shields.io/travis/dar5hak/beautify-text-cli.svg?style=flat-square)](https://travis-ci.org/dar5hak/beautify-text-cli)

[![npm](https://img.shields.io/npm/v/beautify-text-cli.svg?style=flat-square)](https://www.npmjs.com/package/beautify-text-cli)

[![license](https://img.shields.io/npm/l/beautify-text-cli.svg?style=flat-square)](https://www.apache.org/licenses/LICENSE-2.0)

## Install

```sh

$ npm install --global beautify-text-cli

```

## Usage

Input text via stdin or files. See output on stdout.

```sh

$ # Piping

$ echo '"Hello world"' | beautify

“Hello world”

$ # Interactive stdin

$ beautify

"Hello world"

“Hello world”

$ # Files

$ beautify files/*.txt >> combined.txt

```

## Features

Prettifies several typographic marks, some cases are outlined below.

- Single and double quotes

- Apostrophes

- Marks like `(tm)`, `(c)`, `(r)` and `(p)` into `™`, `©`, `®` and `§`

- Long dashes, like `---` into `—`

- `..`, `...`, etc into `…` (but `?..`, `!..` aren't transformed)

- `+-` into `±`

## License

MIT © [Darshak Parikh](https://github.com/dar5hak)