99 lines
2.8 KiB
Markdown
99 lines
2.8 KiB
Markdown
# slug
|
|
|
|
Package `slug` generate slug from Unicode string, URL-friendly slugify with
|
|
multiple languages support.
|
|
|
|
[](https://pkg.go.dev/github.com/gosimple/slug)
|
|
[](https://github.com/gosimple/slug/actions/workflows/tests.yml)
|
|
[](https://codecov.io/gh/gosimple/slug)
|
|
[](https://github.com/gosimple/slug/releases)
|
|
|
|
## Example
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"fmt"
|
|
"github.com/gosimple/slug"
|
|
)
|
|
|
|
func main() {
|
|
text := slug.Make("Hellö Wörld хелло ворлд")
|
|
fmt.Println(text) // Will print: "hello-world-khello-vorld"
|
|
|
|
someText := slug.Make("影師")
|
|
fmt.Println(someText) // Will print: "ying-shi"
|
|
|
|
enText := slug.MakeLang("This & that", "en")
|
|
fmt.Println(enText) // Will print: "this-and-that"
|
|
|
|
deText := slug.MakeLang("Diese & Dass", "de")
|
|
fmt.Println(deText) // Will print: "diese-und-dass"
|
|
|
|
slug.Lowercase = false // Keep uppercase characters
|
|
deUppercaseText := slug.MakeLang("Diese & Dass", "de")
|
|
fmt.Println(deUppercaseText) // Will print: "Diese-und-Dass"
|
|
|
|
slug.CustomSub = map[string]string{
|
|
"water": "sand",
|
|
}
|
|
textSub := slug.Make("water is hot")
|
|
fmt.Println(textSub) // Will print: "sand-is-hot"
|
|
}
|
|
```
|
|
|
|
## Design
|
|
|
|
This library will always returns clean output from any Unicode string
|
|
containing only the following ASCII characters:
|
|
|
|
* numbers: `0-9`
|
|
* small letters: `a-z`
|
|
* big letters: `A-Z` (only if you set `Lowercase` to `false`)
|
|
* minus sign: `-`
|
|
* underscore: `_`
|
|
|
|
Minus sign and underscore characters will never appear at the beginning or
|
|
the end of the returned string.
|
|
|
|
Thanks to context-insensitive transliteration of Unicode characters to ASCII
|
|
output returned string is safe for URL slugs and filenames.
|
|
|
|
## Requests or bugs?
|
|
|
|
<https://github.com/gosimple/slug/issues>
|
|
|
|
If your language is missing you could add it in `languages_substitution.go`
|
|
file.
|
|
|
|
In case of missing proper Unicode characters transliteration to ASCII you could
|
|
add them to underlying library:
|
|
<https://github.com/gosimple/unidecode>.
|
|
|
|
## Installation
|
|
|
|
```shell
|
|
go get -u github.com/gosimple/slug
|
|
```
|
|
|
|
## Benchmarking
|
|
|
|
```shell
|
|
go test -run=NONE -bench=. -benchmem -count=6 ./... > old.txt
|
|
# make changes
|
|
go test -run=NONE -bench=. -benchmem -count=6 ./... > new.txt
|
|
|
|
go install golang.org/x/perf/cmd/benchstat@latest
|
|
|
|
benchstat old.txt new.txt
|
|
```
|
|
|
|
## License
|
|
|
|
The source files are distributed under the
|
|
[Mozilla Public License, version 2.0](http://mozilla.org/MPL/2.0/),
|
|
unless otherwise noted.
|
|
Please read the [FAQ](http://www.mozilla.org/MPL/2.0/FAQ.html)
|
|
if you have further questions regarding the license.
|