https://github.com/vercel/title

A service for capitalizing your title properly
https://github.com/vercel/title

capitalize service title vercel

Last synced: 8 days ago
JSON representation

A service for capitalizing your title properly

• Host: GitHub
• URL: https://github.com/vercel/title
• Owner: vercel
• License: mit
• Created: 2018-01-18T18:12:56.000Z (almost 7 years ago)
• Default Branch: main
• Last Pushed: 2024-06-08T20:32:21.000Z (5 months ago)
• Last Synced: 2024-10-29T14:58:41.453Z (15 days ago)
• Topics: capitalize, service, title, vercel
• Language: JavaScript
• Homepage: https://title.sh
• Size: 245 KB
• Stars: 585
• Watchers: 55
• Forks: 35
• Open Issues: 7
• Metadata Files:
  • Readme: readme.md
  • License: license.md

Awesome Lists containing this project

README

        
# Title

This package correctly capitalizes your titles as per [The Chicago Manual of Style](http://www.chicagomanualofstyle.org/home.html). Furthermore, all of

Vercel's product names are capitalized properly as well.

## Usage

Firstly, install the package:

```bash

yarn add title

```

Then load it and convert any input:

```js

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:

```js

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:

```bash

yarn global add title

```

Next, run it:

```bash

title "tHe cHicaGo maNual oF StyLe"

# Will result in:

# "The Chicago Manual of Style"

```

To see all available options, run:

```bash

title -h

```

## Contributing

1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) 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.

## Authors

- Leo Lamprecht ([@leo](https://x.com/leo))

- Josh Junon ([@Qix-](https://github.com/Qix-))