A minimal and yet powerful slug library.
Last updated 2 years ago by ionicabizau .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install slugly 
SYNC missed versions from official npm registry.


Support me on Patreon Buy me a book PayPal Ask me anything Version Downloads Get help on Codementor

Buy Me A Coffee

A minimal and yet powerful library to generate slugs—human-readable URL parts.

:cloud: Installation

# Using npm
npm install --save slugly

# Using yarn
yarn add slugly

:clipboard: Example

const slugly = require("slugly");

// Simple usage
console.log(slugly("Hello World"));
// => hello-world

// Using Romanian diacritics
console.log(slugly("Salutări din București!"));
// => salutari-din-bucuresti

// Using special characters
console.log(slugly("I ♥ You!"));
// => i-love-you

// Long dashes
console.log(slugly("2016 — What a year!"));
// => 2016-what-a-year

// Add a new character to the charmap
slugly.charmap["????"] = "joy"
console.log(slugly("I am full of ????"));
// => i-am-full-of-joy

:question: Get Help

There are few ways to get help:

  1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.

  2. For bug reports and feature requests, open issues. :bug:

  3. For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation


Accepts a string as input, and returns its slug.


  • String input: The input string to slugify.


  • String The slug.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

  • Starring and sharing the projects you like :rocket:

  • Buy me a book—I love books! I will remember you after years if you buy me one. :grin: :book:

  • PayPal—You can make one-time donations via PayPal. I'll probably buy a coffee tea. :tea:

  • Support me on Patreon—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

  • Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

Thanks! :heart:

:dizzy: Where is this library used?

If you are using this library in one of your projects, add it in this list. :sparkles:

:scroll: License

MIT © Ionică Bizău

Current Tags

  • 1.0.3                                ...           latest (2 years ago)

4 Versions

  • 1.0.3                                ...           2 years ago
  • 1.0.2                                ...           2 years ago
  • 1.0.1                                ...           2 years ago
  • 0.0.1                                ...           2 years ago
Maintainers (1)
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (1)
Dev Dependencies (0)

Copyright 2014 - 2016 © |