Skip to content

Latest commit

 

History

History
69 lines (45 loc) · 1.33 KB

readme.md

File metadata and controls

69 lines (45 loc) · 1.33 KB

Title

This package correctly capitalizes your titles as per The Chicago Manual of Style.

Usage

Install the package:

pnpm add title

Then, import it and convert any input text:

import title from 'title'

title('tHe cHicaGo maNual oF StyLe')

// Will result in:
// "The Chicago Manual of Style"

You can pass words that should be capitalized as specified:

title('FaCEbook is great', {
  special: [ 'facebook' ]
})

// Will result in:
// "facebook is great"

Command Line

You can also convert titles in the command line. Install the package globally:

pnpm add -g title

Next, run it:

title "tHe cHicaGo maNual oF StyLe"

# Will result in:
# "The Chicago Manual of Style"

To see all available options, run:

title -h

Contributing

  1. Fork this repository to your own GitHub account and then clone it to your local device
  2. Uninstall title if it's already installed: pnpm remove -g title
  3. Link it to the global module directory: pnpm link

After that, you can use the title command everywhere.

Original Authors