# @eatingdots/title

> Capitalize titles properly

Latest version **3.5.6** (published 2022-08-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install @eatingdots/title
pnpm add @eatingdots/title
yarn add @eatingdots/title
bun add @eatingdots/title
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.5.6 |
| Published | 2022-08-10 |
| First published | 2022-08-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 9.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Wlad Paiva |
| Maintainers | eatingdots |
| Keywords | title, capitalize, chicago, manual, of, style |

## Links

- npm: https://www.npmjs.com/package/@eatingdots/title
- Repository: https://github.com/eatingdots/title
- Homepage: https://github.com/eatingdots/title#readme
- Issues: https://github.com/eatingdots/title/issues
- npm.io page: https://npm.io/package/@eatingdots/title

## Dependencies (1)

- [remove-accents](https://npm.io/package/remove-accents.md) ^0.4.2

## Recent versions

- 3.5.6 (latest) — 2022-08-10
- 3.5.5 — 2022-08-10
- 3.5.4 — 2022-08-10
- 3.5.3 — 2022-08-10
- 3.5.2 — 2022-08-10
- 3.5.1 — 2022-08-10
- 3.5.0 — 2022-08-10

## README

# Title

This package is based on [Vercel's title package](https://github.com/vercel/title) and correctly capitalizes your titles as per [The Chicago Manual of Style](http://www.chicagomanualofstyle.org/home.html). Furthermore, all of
Eating Dots's product names are capitalized properly as well.

## Usage

Firstly, install the package:

```bash
npm i @eatingdots/title
```

Then load it and convert any input:

```js
const title = require("@eatingdots/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!

## 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. Link it to the global module directory: `npm link <path-to-repo>`

## Authors

- Wlad Paiva ([@wladiston](https://twitter.com/thewladpaiva))
- Leo Lamprecht ([@notquiteleo](https://twitter.com/notquiteleo))
- Josh Junon ([@Qix-](https://github.com/Qix-))

---
_Source: https://npm.io/package/@eatingdots/title · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._