Slugify.MultiLang 1.0.1

Slugify.MultiLang

A multi-language, dependency-free slug generator for .NET — a faithful C# port of the popular slugify JavaScript library, with extended locale support and sensible handling of CJK, Arabic, and other non-Latin scripts.

English | 简体中文

What it does

Turn any string into a clean, URL-safe slug:

"Director Fu: Your alt account got exposed again!"  →  "director-fu-your-alt-account-got-exposed-again"
"Café au lait & cròissant"                          →  "cafe-au-lait-and-croissant"
"傅总：你的马甲 又又又掉了！"                          →  "傅总-你的马甲-又又又掉了"

It transliterates accented Latin, Greek, Cyrillic, Armenian, Georgian, Vietnamese and more into ASCII, maps common symbols and currencies to words, applies locale-specific rules, and preserves scripts that have no meaningful romanization (CJK, Arabic, Devanagari, Thai, …) so slugs stay readable in any language.

Features

• No dependencies — a single static helper, targets .NET Standard 2.0 (works on .NET Framework 4.6.1+, .NET Core, .NET 5–8+, Mono, Xamarin, Unity).
• Huge built-in charmap — Latin (incl. Extended), Greek, Cyrillic (incl. Kazakh), Armenian, Georgian, Vietnamese, currencies, punctuation, and math/misc symbols.
• Locale-aware — per-language overrides for bg, de, es, fr, pt, uk, vi, da, nb, it, nl, sv (e.g. German ä → ae, & → und).
• Script-preserving — CJK / Arabic / Devanagari / Thai letters are kept as-is rather than dropped.
• Configurable — replacement char, lowercasing, strict mode, trimming, and a custom remove-regex.
• Extensible — register your own character mappings at runtime via Extend.

How It Works

Every string goes through a five-step pipeline:

1. NFC normalize — Unicode Normalization Form C is applied so that pre-composed and decomposed forms are treated identically.
2. Per-character translation — each character (including surrogate pairs for supplementary-plane code points) is looked up in order:
   1. Locale override map — if Locale is set and that locale has an entry for the character.
   2. Global charmap — Latin Extended, Greek, Cyrillic, Armenian, Georgian, Vietnamese, currencies, math symbols, CJK punctuation, …
   3. Passthrough — characters with no entry are kept as-is.
3. Remove pass — the built-in (or custom Remove) regex strips characters not useful in a URL.
4. Strict pass (Strict = true by default) — the Unicode-aware pattern [^\p{L}\p{N}\s] removes anything that is not a letter, digit, or whitespace. This is how non-Latin scripts are preserved: Arabic, CJK, Hangul, Kana, Thai consonants, and Devanagari consonants all satisfy \p{L} and survive untouched.
5. Finalize — whitespace runs are collapsed into the replacement char (default -); optional trim and lower-case are applied.

Script-handling strategies

Thai and Devanagari (Hindi) — combining marks stripped

Thai base consonants and Devanagari base consonants are Unicode letters (\p{L}) and survive intact. Their combining vowel signs and tone marks are Unicode combining marks (\p{M}) — e.g. Thai ้ ู ็ or Devanagari ि ा ी. With Strict = true (the default) these marks are removed, leaving consonant skeletons in the slug. Set Strict = false if phonetically complete Thai / Devanagari slugs are needed.

Arabic — letters preserved, diacritics dropped

Arabic letters satisfy \p{L} and are preserved. Harakat (short-vowel diacritics such as َ ِ ُ) are combining marks (\p{M}) and are stripped by strict mode, which is fine for slug purposes since Arabic URLs routinely omit them.

Installation

This repository ships the source directly. Add a project reference to csharp/src/Slugify.MultiLang/Slugify.MultiLang.csproj, or drop SlugifyHelper.cs and SlugifySlugOptions.cs into your project.

<ItemGroup>
  <ProjectReference Include="path/to/Slugify.MultiLang/Slugify.MultiLang.csproj" />
</ItemGroup>

Usage

using Slugify.MultiLang;

// Extension-method style (default options)
string slug = "Hello, World!".Slugify();
// → "hello-world"

// Static call with options
string s = SlugifyHelper.Slugify("Müller & Söhne", new SlugifySlugOptions
{
    Locale = "de"   // German: ü → ue, ö → oe, & → und
});
// → "mueller-und-soehne"

// Custom replacement character
"Some Text".Slugify("_");
// → "some_text"

Options

All options live on SlugifySlugOptions:

Extending the charmap

SlugifyHelper.Extend(new Dictionary<char, string>
{
    { '☂', "umbrella" },
    { '♛', "queen" },
});

"☂♛".Slugify(); // → "umbrella-queen"

Demo

A runnable console demo showing 23 languages lives in csharp/demo:

cd csharp
dotnet run --project demo/Slugify.MultiLang.Demo

All examples below use the same source sentence — "傅总：你的马甲 又又又掉了！" ("Director Fu: Your alt account got exposed again and again and again!") — translated into each target language.

With explicit locale mapping

vi note: the locale entry only maps Đ/đ → D/d; the extensive Vietnamese diacritics (ấ, ề, ộ, …) are handled by the global charmap.

Charmap fallback (no dedicated locale entry)

no note: Norwegian Bokmål (nb) does have a locale entry. The demo passes no which falls back to charmap. Use Locale = "nb" for proper Bokmål mapping (ø→oe, å→aa, &→og).

Script-preserving (Unicode passthrough)

Non-Latin scripts with no charmap entries are preserved via \p{L}:

† Combining vowel marks (\p{M}) are stripped by strict mode — see Thai and Devanagari note in the How It Works section.

Project layout

csharp/
├── Slugify.MultiLang.slnx              # solution
├── src/Slugify.MultiLang/             # the library (netstandard2.0)
│   ├── SlugifyHelper.cs               # core logic + charmaps + locale maps
│   └── SlugifySlugOptions.cs          # options
└── demo/Slugify.MultiLang.Demo/       # multi-language console demo (net8.0)

Credits

Charmap and behavior are derived from simov/slugify (MIT).

License

Released under the MIT License — free for any use, including commercial. Do whatever you like with it.