Philiprehberger.Slugify
0.1.8
dotnet add package Philiprehberger.Slugify --version 0.1.8
NuGet\Install-Package Philiprehberger.Slugify -Version 0.1.8
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Philiprehberger.Slugify" Version="0.1.8" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Philiprehberger.Slugify" Version="0.1.8" />
<PackageReference Include="Philiprehberger.Slugify" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Philiprehberger.Slugify --version 0.1.8
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Philiprehberger.Slugify, 0.1.8"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Philiprehberger.Slugify@0.1.8
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Philiprehberger.Slugify&version=0.1.8
#tool nuget:?package=Philiprehberger.Slugify&version=0.1.8
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Philiprehberger.Slugify
Convert text to clean, URL-safe slugs with Unicode diacritic handling, separator collapsing, and max length enforcement.
Installation
dotnet add package Philiprehberger.Slugify
Usage
using Philiprehberger.Slugify;
Slug.Generate("Hello, World!"); // "hello-world"
Slug.Generate("Héllo Wörld"); // "hello-world"
Slug.Generate(" Multiple Spaces "); // "multiple-spaces"
Slug.Generate("C# is great!"); // "c-is-great"
Slug.Generate("über cool blog post"); // "uber-cool-blog-post"
Custom options
var options = new SlugOptions
{
Separator = "_",
Lowercase = false,
MaxLength = 50
};
Slug.Generate("Hello World", options); // "Hello_World"
How it works
- Normalise to Unicode NFD to decompose accented characters.
- Strip non-spacing combining marks (removes diacritics).
- Optionally convert to lowercase.
- Replace every run of non-alphanumeric characters with the separator.
- Collapse consecutive separators into one.
- Trim separators from both ends.
- Truncate to
MaxLength, trimming any trailing separator.
API
Slug
| Method | Description |
|---|---|
Generate(string text, SlugOptions? options) |
Convert text to a URL slug |
SlugOptions
| Property | Default | Description |
|---|---|---|
MaxLength |
200 |
Maximum slug length; truncates at a separator boundary |
Separator |
"-" |
Word separator inserted between tokens |
Lowercase |
true |
Convert result to lowercase |
Development
dotnet build src/Philiprehberger.Slugify.csproj --configuration Release
Support
If you find this project useful:
License
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.