Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thangngoc89/ocaml-slug
Url safe slug generator for OCaml
https://github.com/thangngoc89/ocaml-slug
Last synced: 4 months ago
JSON representation
Url safe slug generator for OCaml
- Host: GitHub
- URL: https://github.com/thangngoc89/ocaml-slug
- Owner: thangngoc89
- License: mit
- Created: 2021-07-05T20:06:10.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-07-19T04:40:08.000Z (over 3 years ago)
- Last Synced: 2024-08-04T01:28:28.753Z (6 months ago)
- Language: OCaml
- Size: 86.9 KB
- Stars: 17
- Watchers: 1
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - ocaml-slug
README
# 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 =
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 =
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 =
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 =
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)