slugify

What is slugify?

The slugify npm package is designed to convert strings into URL-friendly slugs. This is particularly useful for creating readable and SEO-friendly URLs from titles, names, or any text that may contain special characters, spaces, or uppercase letters. Slugify simplifies the process of generating slugs by replacing spaces and special characters with hyphens or other user-defined characters, making strings safe for URLs.

What are slugify's main functionalities?

Basic slugification

This feature demonstrates the basic usage of slugify to convert a string into a lowercase slug, replacing spaces and special characters with hyphens.

"use strict"; const slugify = require('slugify'); const title = 'Some Article Title!'; const slug = slugify(title); console.log(slug); // Output: 'some-article-title'

Custom replacement character

This feature shows how to use a custom replacement character (in this case, an underscore) instead of the default hyphen.

"use strict"; const slugify = require('slugify'); const title = 'Some Article Title!'; const slug = slugify(title, '_'); console.log(slug); // Output: 'some_article_title'

Locale-specific slugification

This feature illustrates the ability to handle locale-specific characters appropriately, converting them based on the specified locale.

"use strict"; const slugify = require('slugify'); const title = 'I ♥ Dogs'; const slug = slugify(title, { locale: 'de' }); console.log(slug); // Output: 'i-liebe-dogs'

Removing characters not allowed in URLs

This feature demonstrates the removal of specific characters not allowed or desired in the final slug, using a regular expression.

"use strict"; const slugify = require('slugify'); const title = 'New! Improved! Slugify!'; const slug = slugify(title, { remove: /[!]/g }); console.log(slug); // Output: 'new-improved-slugify'

Other packages similar to slugify

speakingurl

SpeakingURL is a package similar to slugify that generates human-readable, SEO-friendly URLs. It offers extensive language support and customization options, making it a strong alternative. However, slugify tends to be simpler to use for basic slugification needs.

limax

Limax is another alternative that focuses on creating slugs from strings with support for multiple languages, including Chinese, Japanese, and Korean. It provides more extensive language support compared to slugify but might be more complex for simple use cases.

url-slug

url-slug is a package that offers similar functionality to slugify, allowing for customizable and URL-friendly string transformation. It differs in its API and customization options, providing a different approach to slug generation that some users might prefer.

README

Slugify

This is vanilla javascript port of node-slug so all credits goes to dodo. The only difference is that this port does not support unicode characters!

DEPRECATED!

Use the original module slug instead as it's already been ported to vanilla javascript.

Install

$ npm install slugify

Usage

var slugify = require('slugify');

slugify('some string'); // returns some-string
slugify('some string', '_'); // if you prefer something else then '-' as seperator

Tests

$ mocha