Skip to main content

​
Slugify

Generate URL-safe, SEO-friendly slugs from Persian text.

​
Basic Usage

import { slugify } from "@persian-tools/persian-tools";

console.log(slugify("معرفی محصولات جدید"));
// Output: "معرفی-محصولات-جدید"

console.log(slugify("راهنمای خرید سریع!"));
// Output: "راهنمای-خرید-سریع"

​
API Reference

​
text
string
required
Persian text to convert to slug
​
result
string
URL-safe slug with hyphens separating words

​
Examples

​
Blog Post URLs

import { slugify } from "@persian-tools/persian-tools";

const createBlogUrl = (title: string, id: number): string => {
	const slug = slugify(title);
	return `/blog/${id}/${slug}`;
};

console.log(createBlogUrl("آموزش برنامه نویسی", 123));
// "/blog/123/آموزش-برنامه-نویسی"

​
Product URLs

import { slugify } from "@persian-tools/persian-tools";

interface Product {
	id: number;
	name: string;
	category: string;
}

const generateProductUrl = (product: Product): string => {
	const categorySlug = slugify(product.category);
	const nameSlug = slugify(product.name);
	return `/products/${categorySlug}/${nameSlug}-${product.id}`;
};

const product = {
	id: 456,
	name: "گوشی هوشمند",
	category: "الکترونیک",
};

console.log(generateProductUrl(product));
// "/products/الکترونیک/گوشی-هوشمند-456"

​
Clean Special Characters

import { slugify } from "@persian-tools/persian-tools";

console.log(slugify("نقد و بررسی: بهترین لپ‌تاپ‌ها!"));
// "نقد-و-بررسی-بهترین-لپ-تاپ-ها"

console.log(slugify("قیمت (ویژه) محصول"));
// "قیمت-ویژه-محصول"

​
Use Cases

Generate SEO-friendly URLs:
const post = {
  title: 'معرفی فناوری جدید',
  slug: slugify('معرفی فناوری جدید')
};
Create product URLs:
const productUrl = `/shop/${slugify(category)}/${slugify(productName)}`;

Persian Characters

Validate Persian text

URL Fix

Decode Persian URLs

​
Type Definition

function slugify(text: string): string;