Skip to content
This repository has been archived by the owner on Feb 15, 2022. It is now read-only.
/ title Public archive
forked from vercel/title

A service for capitalizing your title properly

License

Notifications You must be signed in to change notification settings

dendronhq/title

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

96 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Title

⚠️ This was a fork of vercel/title with some bug fixes by the Dendron team, but those fixes have now been merged back into the original package. Please use the original package instead.

This package correctly capitalizes your titles as per The Chicago Manual of Style. Furthermore, all of Vercel's product names are capitalized properly as well.

Usage

Firstly, install the package:

yarn add title

Then load it and convert any input:

const title = require('title')

title('tHe cHicaGo maNual oF StyLe')

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

You can even pass words that should be capitalized as specified:

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

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

That's it!

Command Line

You can also convert titles in the command line, if you want. Install the package globally:

yarn global add 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: yarn global remove title
  3. Link it to the global module directory: yarn link

After that, you can use the title command everywhere.

Author

About

A service for capitalizing your title properly

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%