Skip to content

Commit aaae600

Browse files
committed
rebuild docs
1 parent afd6aa0 commit aaae600

File tree

2 files changed

+36
-28
lines changed

2 files changed

+36
-28
lines changed

.verb.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,19 @@ Trim trailing whitespace from the returned string. This option is included since
8888
wrap(str, {trim: true});
8989
```
9090

91+
### options.cut
92+
93+
Type: `Boolean`
94+
95+
Default: `false`
96+
97+
Break a word between any two letters when the word is longer than the specified width.
98+
99+
**Example:**
100+
101+
```js
102+
wrap(str, {cut: true});
103+
```
91104

92105
## Related projects
93106
{%= related(['wordcount', 'unique-words', 'common-words', 'shuffle-words']) %}

README.md

Lines changed: 23 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
1-
# word-wrap [![NPM version](https://badge.fury.io/js/word-wrap.svg)](http://badge.fury.io/js/word-wrap) [![Build Status](https://travis-ci.org/jonschlinkert/word-wrap.svg)](https://travis-ci.org/jonschlinkert/word-wrap)
1+
# word-wrap [![NPM version](https://badge.fury.io/js/word-wrap.svg)](http://badge.fury.io/js/word-wrap) [![Build Status](https://travis-ci.org/jonschlinkert/word-wrap.svg)](https://travis-ci.org/jonschlinkert/word-wrap)
22

33
> Wrap words to a specified length.
44
5-
## Install with [npm](npmjs.org)
5+
Install with [npm](https://www.npmjs.com/)
66

7-
```bash
8-
npm i word-wrap --save
7+
```sh
8+
$ npm i word-wrap --save
99
```
1010

11-
1211
## Usage
1312

1413
```js
@@ -27,11 +26,9 @@ Results in:
2726
aliquip ex ea commodo consequat.
2827
```
2928

30-
3129
## Options
3230

33-
![image](https://cloud.githubusercontent.com/assets/383994/6543728/7a381c08-c4f6-11e4-8b7d-b6ba197569c9.png)
34-
31+
[![image](https://cloud.githubusercontent.com/assets/383994/6543728/7a381c08-c4f6-11e4-8b7d-b6ba197569c9.png)](https://www.npmjs.com/)
3532

3633
### options.width
3734

@@ -47,12 +44,11 @@ The width of the text before wrapping to a new line.
4744
wrap(str, {width: 60});
4845
```
4946

50-
5147
### options.indent
5248

5349
Type: `String`
5450

55-
Default: ` ` (two spaces)
51+
Default: `` (two spaces)
5652

5753
The string to use at the beginning of each line.
5854

@@ -62,7 +58,6 @@ The string to use at the beginning of each line.
6258
wrap(str, {indent: ' '});
6359
```
6460

65-
6661
### options.newline
6762

6863
Type: `String`
@@ -77,7 +72,6 @@ The string to use at the end of each line.
7772
wrap(str, {newline: '\n\n'});
7873
```
7974

80-
8175
### options.trim
8276

8377
Type: `Boolean`
@@ -92,50 +86,51 @@ Trim trailing whitespace from the returned string. This option is included since
9286
wrap(str, {trim: true});
9387
```
9488

95-
9689
### options.cut
9790

9891
Type: `Boolean`
9992

10093
Default: `false`
10194

102-
The string is always wrapped at the specified width. So if you have a word that is larger than the given width, it is broken apart.
95+
Break a word between any two letters when the word is longer than the specified width.
10396

10497
**Example:**
10598

10699
```js
107100
wrap(str, {cut: true});
108101
```
109102

110-
111103
## Related projects
112-
* [wordcount](https://github.com/jonschlinkert/wordcount): Count the words in string. Has basic support for Cyrillic and CJK.
113-
* [unique-words](https://github.com/jonschlinkert/unique-words): Return the unique words in a string or array.
114-
* [common-words](https://github.com/jonschlinkert/common-words): Updated list (JSON) of the 100 most common words in the English language. Useful for excluding these words from arrays.
115-
* [shuffle-words](https://github.com/jonschlinkert/shuffle-words): Shuffle the words in a string and optionally the letters in each word using the Fisher-Yates algorithm. Useful for creating test fixtures, benchmarking samples, etc.
104+
105+
* [common-words](https://github.com/jonschlinkert/common-words): Updated list (JSON) of the 100 most common words in the English language. Useful for… [more](https://github.com/jonschlinkert/common-words)
106+
* [shuffle-words](https://github.com/jonschlinkert/shuffle-words): Shuffle the words in a string and optionally the letters in each word using the… [more](https://github.com/jonschlinkert/shuffle-words)
107+
* [unique-words](https://github.com/jonschlinkert/unique-words): Return the unique words in a string or array.
108+
* [wordcount](https://github.com/jonschlinkert/wordcount): Count the words in string. Has basic support for Cyrillic and CJK.
116109

117110
## Running tests
111+
118112
Install dev dependencies:
119113

120-
```bash
121-
npm i -d && npm test
114+
```sh
115+
$ npm i -d && npm test
122116
```
123117

124118
## Contributing
125-
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/word-wrap/issues)
119+
120+
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/word-wrap/issues/new)
126121

127122
## Author
128123

129124
**Jon Schlinkert**
130-
131-
+ [github/jonschlinkert](https://github.com/jonschlinkert)
132-
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
133125

126+
+ [github/jonschlinkert](https://github.com/jonschlinkert)
127+
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
134128

135129
## License
136-
Copyright (c) 2014-2015 Jon Schlinkert
137-
Released under the MIT license
130+
131+
Copyright © 2015 Jon Schlinkert
132+
Released under the MIT license.
138133

139134
***
140135

141-
_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on April 19, 2015._
136+
_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on July 17, 2015._

0 commit comments

Comments
 (0)