EXAMPLES.md

Slugger Examples

Basic slug generation

package main

import (
	"fmt"

	"github.com/kashifkhan0771/utils/slugger"
)

func main() {
	s := slugger.New(map[string]string{}, false)
	fmt.Println(s.Slug("Wôrķšpáçè ~~sèťtïñğš~~", ""))
}

Output:

workspace-settings

Generate slugs with different separators

package main

import (
	"fmt"

	"github.com/kashifkhan0771/utils/slugger"
)

func main() {
	s := slugger.New(map[string]string{}, false)
	// Will use the default separator
	fmt.Println(s.Slug("Wôrķšpáçè ~~sèťtïñğš~~", ""))
	// Will use the custom separator
	fmt.Println(s.Slug("Wôrķšpáçè ~~sèťtïñğš~~", "/"))
}

Output:

workspace-settings
workspace/settings

Generate slugs with substitutions

package main

import (
	"fmt"

	"github.com/kashifkhan0771/utils/slugger"
)

func main() {
	s := slugger.New(map[string]string{"%": "percent", "€": "euro"}, false)
	fmt.Println(s.Slug("10% or 5€", ""))
}

Output:

10-percent-or-5-euro

Generate slugs with emoji replacement

package main

import (
	"fmt"

	"github.com/kashifkhan0771/utils/slugger"
)

func main() {
	s := slugger.New(map[string]string{}, true)
	fmt.Println(s.Slug("a 😺, 🐈‍⬛, and a 🦁 go to 🏞️", ""))
}

Output:

a-grinning-cat-black-cat-and-a-lion-go-to-national-park

Remove stop words

package main

import (
	"fmt"

	"github.com/kashifkhan0771/utils/slugger"
)

func main() {
	s := slugger.New(map[string]string{"and": "", "the": "", "of": ""}, false)
	fmt.Println(s.Slug("The Beauty and the Power of Nature", ""))
}

Output:

beauty-power-nature

Remove stop words

package main

import (
	"fmt"

	"github.com/kashifkhan0771/utils/slugger"
)

func main() {
	s := slugger.New(map[string]string{"and": "", "the": "", "of": ""}, false)
	fmt.Println(s.Slug("The Beauty and the Power of Nature", ""))
}

Output:

beauty-power-nature

Change substitutions dynamically

package main

import (
	"fmt"

	"github.com/kashifkhan0771/utils/slugger"
)

func main() {
	const input = "The Beauty and the Power of Nature"
	s := slugger.New(map[string]string{}, false)
	fmt.Println(s.Slug(input, ""))
	s.AddSubstitution("and", "")
	fmt.Println(s.Slug(input, ""))
    s.AddSubstitution("the", "")
	fmt.Println(s.Slug(input, ""))
	s.RemoveSubstitution("and")
	fmt.Println(s.Slug(input, ""))
    s.ReplaceSubstitution("the", "a")
	fmt.Println(s.Slug(input, ""))
}

Output:

the-beauty-and-the-power-of-nature
the-beauty-the-power-of-nature
beauty-power-of-nature
beauty-and-power-of-nature
a-beauty-and-a-power-of-nature
the-beauty-and-the-power-of-nature