README
¶
slug
Package slug generate slug from unicode string, URL-friendly slugify with
multiple languages support.
Example
package main
import(
"github.com/gosimple/slug"
"fmt"
)
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.CustomSub = map[string]string{
"water": "sand",
}
textSub := slug.Make("water is hot")
fmt.Println(textSub) // Will print 'sand-is-hot'
}
Requests or bugs?
https://github.com/gosimple/slug/issues
Installation
go get -u github.com/gosimple/slug
License
The source files are distributed under the Mozilla Public License, version 2.0, unless otherwise noted. Please read the FAQ if you have further questions regarding the license.
Documentation
¶
Overview ¶
Package slug generate slug from unicode string, URL-friendly slugify with multiple languages support.
Example:
package main
import(
"github.com/gosimple/slug"
"fmt"
)
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.CustomSub = map[string]string{
"water": "sand",
}
textSub := slug.Make("water is hot")
fmt.Println(textSub) // Will print 'sand-is-hot'
}
Requests or bugs?
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // Custom substitution map CustomSub map[string]string // Custom rune substitution map CustomRuneSub map[rune]string // Maximum slug length. It's smart so it will cat slug after full word. // By default slugs aren't shortened. // If MaxLength is smaller than length of the first word, then returned // slug will contain only substring from the first word truncated // after MaxLength. MaxLength int )
Functions ¶
func Make ¶
Make returns slug generated from provided string. Will use "en" as language substitution.
func MakeLang ¶
MakeLang returns slug generated from provided string and will use provided language for chars substitution.
func Substitute ¶
Substitute returns string with superseded all substrings from provided substitution map.
Types ¶
This section is empty.
Source Files
¶
- default_substitution.go
- doc.go
- languages_substitution.go
- slug.go