slugly

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

☁️ Installation

# Using npm 
npm install --save slugly
 
# Using yarn 
yarn add slugly

📋 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

❓ 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. 🐛
3. For direct and quick help, you can use Codementor. 🚀

📝 Documentation

slugly(input)

Accepts a string as input, and returns its slug.

Params

• String input: The input string to slugify.

Return

• String The slug.

😋 How to contribute

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

💖 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 🚀

• —I love books! I will remember you after years if you buy me one. 😁 📖

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

• —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! ❤️

💫 Where is this library used?

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

• bloggify-markdown-adapter
• bloggify-page

📜 License

MIT © Ionică Bizău