Slugify

https://hexdocs.pm/slugify/1.3.1
Admin
Slugify is a library that transforms strings from any language into URL-friendly slugs through...
Tokens:742
Snippets:9
Trust Score:9
Update:6 months ago
Show doc for...
Tokens:
Raw
### Slugify usage examples

Source: https://hexdocs.pm/slugify/1.3.1/Slug.html

Examples demonstrating basic slugification, custom separators, case retention, truncation, and character ignoring.

```elixir
iex> Slug.slugify("Hello, World!")
"hello-world"

iex> Slug.slugify("Madam, I'm Adam", separator: "")
"madamimadam"

iex> Slug.slugify("StUdLy CaPs", lowercase: false)
"StUdLy-CaPs"

iex> Slug.slugify("Call me maybe", truncate: 10)
"call-me"

iex> Slug.slugify("你好，世界", ignore: ["你", "好"])
"你好-shi-jie"
```

--------------------------------

### Slugify Function

Source: https://hexdocs.pm/slugify/1.3.1/Slug.html

The `slugify/2` function takes a string and an optional map of options to generate a URL-friendly slug. It handles Unicode transliteration, punctuation removal, and whitespace replacement.

```APIDOC
## slugify(string, opts \\ [])

### Description
Returns `string` as a slug or `nil` if it failed.

### Method
N/A (Function within a library)

### Endpoint
N/A (Function within a library)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Function Signature
```elixir
slugify(String.t(), Keyword.t()) :: String.t() | nil
```

### Options
* `:separator` - Replace whitespaces with this string. Leading, trailing or repeated whitespaces are trimmed. Defaults to `-`.
* `:lowercase` - Set to `false` if you wish to retain capitalization. Defaults to `true`.
* `:truncate` - Truncates slug at this character length, shortened to the nearest word.
* `:ignore` - Pass in a string (or list of strings) of characters to ignore.

### Examples
```elixir
iex> Slug.slugify("Hello, World!")
"hello-world"

iex> Slug.slugify("Madam, I'm Adam", separator: "")
"madamimadam"

iex> Slug.slugify("StUdLy CaPs", lowercase: false)
"StUdLy-CaPs"

iex> Slug.slugify("Call me maybe", truncate: 10)
"call-me"

iex> Slug.slugify("你好，世界", ignore: ["你", "好"])
"你好-shi-jie"
```
```

--------------------------------

### Slugify function specification

Source: https://hexdocs.pm/slugify/1.3.1/Slug.html

Type specification for the slugify function.

```elixir
slugify(String.t(), Keyword.t()) :: String.t() | nil
```
Tokens:
Raw