| 1 | # slugify [](https://travis-ci.org/sindresorhus/slugify)
|
| 2 |
|
| 3 | > Slugify a string
|
| 4 |
|
| 5 | Useful for URLs, filenames, and IDs.
|
| 6 |
|
| 7 |
|
| 8 | ## Install
|
| 9 |
|
| 10 | ```
|
| 11 | $ npm install @sindresorhus/slugify
|
| 12 | ```
|
| 13 |
|
| 14 |
|
| 15 | ## Usage
|
| 16 |
|
| 17 | ```js
|
| 18 | const slugify = require('@sindresorhus/slugify');
|
| 19 |
|
| 20 | slugify('I ♥ Dogs');
|
| 21 | //=> 'i-love-dogs'
|
| 22 |
|
| 23 | slugify(' Déjà Vu! ');
|
| 24 | //=> 'deja-vu'
|
| 25 |
|
| 26 | slugify('fooBar 123 $#%');
|
| 27 | //=> 'foo-bar-123'
|
| 28 | ```
|
| 29 |
|
| 30 |
|
| 31 | ## Related
|
| 32 |
|
| 33 | - [filenamify](https://github.com/sindresorhus/filenamify) - Convert a string to a valid safe filename
|
| 34 |
|
| 35 |
|
| 36 | ## License
|
| 37 |
|
| 38 | MIT © [Sindre Sorhus](https://sindresorhus.com)
|