chicago-capitalize v0.1.0

chicago-capitalize

Capitalizes a title according to the Chicago Manual of Style.

Usage

First, install chicago-capitalize as a dependency:

npm install --save chicago-capitalize

Then, use it in your scripts, like so:

var capitalize = require('chicago-capitalize')

var input = 'The quick brown fox jumps over the lazy dog.'
var output = capitalize(input)

// Prints 'The Quick Brown Fox Jumps Over the Lazy Dog.'
console.log(output)

You can also pass an options object. For now, the only option is whitelist: an array of words not to capitalize. Note that it is case-sensitive.

var input = 'Sent from my iPhone.'
var options = { whitelist: ['iPhone'] }
var output = capitalize(input, options)

// Prints 'Sent from My iPhone.'
console.log(output)

Author

Tim De Pauw

License

Copyright © 2015 Tim De Pauw

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.