ocaml-slug

KO | EN

gitlite — search

#javascript #go #machine-learning #deep-learning #linux #docker #nodejs #macos #java #awesome #awesome-list #vue #mcp #ios

(★ 16)

Url safe slug generator for OCaml

ocaml-slug 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ocaml-slug
Url safe slug generator for OCaml

> A URL slug is the part of a URL or link that comes after the domain extension.
>
> In websites the keyword used for your URL slug can be used to SEO optimize the URL by showing Google the structure of your site and the contents of the page in question.

This library turns title into URL-safe slug with support for non-latin characters.

This library uses algorithm and data from [node-slugify](https://github.com/simov/slugify)

## Installation

```
opam install slug
```

If you use [esy](https://esy.sh)

```
esy add @opam/slug
```

## Usage

- OCaml syntax:

```ocaml
Slug.slugify "my string";;
- : string = "my-string"

(* Custom separator *)
Slug.slugify ?sep: "_" "my string";;
- : string = "my_string"

(* Retain uppercase *)
Slug.slugify ?lowercase: false "My String";;
- : string = "My-String"

(* Use locale *)
let with_vi = Slug.(Charmap.mk_charmap [Slug_data.base; Slug_data.vi]);;
- : Charmap.t = <abstr>
Slug.slugify ?charmap: with_vi "Đ";;
- : string = "d" 
Slug.slugify "Đ";;
- : string = "dj"

(* Custom characters map *)
let custom_map = Slug.(Charmap.mk_charmap [Slug_data.base; [ ("M", "z"); ("m", "z") ]]);;
val custom_map : Charmap.t = <abstr>

Slug.slugify ?charmap: custom_map "Mm";;
- : string = "zz"
```

- ReasonML syntax

```reason
Slug.slugify("my string");
- : string = "my-string"

/* Custom separator */
Slug.slugify(~sep = "_", "my string");
- : string = "my_string"

/* Retain uppercase */
Slug.slugify(~lowercase = false, "My String");
- : string = "My-String"

/* Use locale */
let with_vi = Slug.(Charmap.mk_charmap([Slug_data.base, Slug_data.vi]));
let with_vi : Charmap.t = <abstr>
Slug.slugify(~charmap = with_vi, "Đ");
- : string = "d" 
Slug.slugify("Đ");
- : string = "dj"

/* Custom characters map */
let custom_map = Slug.(Charmap.mk_charmap([Slug_data.base, [ ("M", "z"), ("m", "z") ]]));;
let custom_map : Charmap.t = <abstr>

Slug.slugify(~charmap = custom_map, "Mm");
- : string = "zz"
```

## Notice

Please don't send PR to update `data/*`. They are auto-generated from [upstream library](https://github.com/simov/slugify).

Please send PRs about new locales to node-slugify.

If you really need it, you can use a `custom_map` instead.

## License
MIT. Data are downloaded from [node-slugify](https://github.com/simov/slugify)

ocaml-slug

ocaml-slug 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

ocaml-slug

ocaml-slug 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README