summaryrefslogtreecommitdiff
path: root/vendor/github.com/gosimple/slug/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/gosimple/slug/doc.go')
-rw-r--r--vendor/github.com/gosimple/slug/doc.go47
1 files changed, 47 insertions, 0 deletions
diff --git a/vendor/github.com/gosimple/slug/doc.go b/vendor/github.com/gosimple/slug/doc.go
new file mode 100644
index 0000000..f6f764e
--- /dev/null
+++ b/vendor/github.com/gosimple/slug/doc.go
@@ -0,0 +1,47 @@
+// Copyright 2013 by Dobrosław Żybort. All rights reserved.
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+/*
+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.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"
+ }
+
+Requests or bugs?
+
+https://github.com/gosimple/slug/issues
+*/
+package slug