slug-unicode
v1.0.0
Published
A lightweight, dependency-free URL slug generator supporting multilingual unicode transliteration (Hindi, Cyrillic, accented Latin).
Maintainers
Readme
slugify-unicode
A lightweight, dependency-free URL slug generator supporting multilingual unicode transliteration (Hindi/Devanagari, Cyrillic/Russian, and accented Latin scripts).
Features
- 🚀 Zero dependencies — extremely fast and lightweight.
- 🇮🇳 Hindi/Devanagari Support — transliterates Hindi words phonetically (e.g.,
नमस्ते->namaste). - 🇷🇺 Cyrillic Support — transliterates Russian/Cyrillic characters (e.g.,
привет->privet). - 🇪🇺 Accent Stripping — strips accents/diacritics from European characters (e.g.,
bárbaro->barbaro). - 🛠️ Customisable Separator — choose your own word separator (defaults to
-).
Installation
npm install slug-unicodeUsage
const { slugify } = require('slugify-unicode');
// Basic English with special characters
console.log(slugify('Hello World, how are you?'));
// Output: "hello-world-how-are-you"
// Spanish / Accents
console.log(slugify('Canción del verano 2026!'));
// Output: "cancion-del-verano-2026"
// Hindi / Devanagari
console.log(slugify('यह एक बेहतरीन पैकेज है'));
// Output: "yah-ek-bahatareen-paikej-hai"
// Cyrillic / Russian
console.log(slugify('Как дела?'));
// Output: "kak-dela"
// Custom Separator
console.log(slugify('Hello World', { separator: '_' }));
// Output: "hello_world"API
slugify(text, options)
Generates a URL slug from the input string.
| Option | Type | Default | Description |
|---|---|---|---|
| lowercase | boolean | true | Convert the resulting slug to lowercase. |
| separator | string | '-' | Character used to separate words in the slug. |
License
MIT
