js-smart-slug 🐌

A lightweight, zero-dependency JavaScript utility to generate SEO-friendly slugs. It handles complex international characters including German, Polish, Scandinavian, Maltese, and Vietnamese.

Features

• Zero Dependencies: Extremely lightweight.
• Universal Support: Handles accents, diacritics, and special ligatures.
• Smart Mapping:
  • German Umlauts: ä → ae, ß → ss
  • Polish: ł → l, ż → z
  • Vietnamese: đ → d and multi-level tone marks.
  • Maltese: ħ → h, ġ → g
  • etc.
• SEO Optimized: Removes special characters, forces lowercase, and cleans up dashes.

Installation

npm install js-smart-slug

Usage

import { slug } from 'js-smart-slug';

// Standard strings
console.log(slug('Hello World!')); 
// Output: "hello-world"

// German & Special Characters
console.log(slug('Häuser & Boote')); 
// Output: "haeuser-boote"

// Polish
console.log(slug('Zażółć gęślą jaźń')); 
// Output: "zazolc-gesla-jazn"

// Vietnamese
console.log(slug('Tiếng Việt')); 
// Output: "tieng-viet"

// Maltese
console.log(slug('L-Għarb')); 
// Output: "l-gharb"

License

GPL-3.0 License. See LICENSE for details.