Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vercel/title
A service for capitalizing your title properly
https://github.com/vercel/title
capitalize service title vercel
Last synced: about 24 hours 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 (6 months ago)
- Last Synced: 2024-10-29T14:58:41.453Z (about 1 month 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).
## Usage
Install the package:
```bash
pnpm add title
```
Then, import it and convert any input text:
```js
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:
```js
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:
```bash
pnpm add -g 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: `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
- Leo Lamprecht ([@leo](https://x.com/leo))
- Josh Junon ([@Qix-](https://github.com/Qix-))