sanitized_anchor_name: github.com/shurcooL/sanitized_anchor_name Index | Examples | Files

package sanitized_anchor_name

import "github.com/shurcooL/sanitized_anchor_name"

Package sanitized_anchor_name provides a func to create sanitized anchor names.

Its logic can be reused by multiple packages to create interoperable anchor names and links to those anchors.

At this time, it does not try to ensure that generated anchor names are unique, that responsibility falls on the caller.

Index

Examples

Package Files

main.go

func Create Uses

func Create(text string) string

Create returns a sanitized anchor name for the given text.

Code:

anchorName := sanitized_anchor_name.Create("This is a header")

fmt.Println(anchorName)

Output:

this-is-a-header

Code:

fmt.Println(sanitized_anchor_name.Create("This is a header"))
fmt.Println(sanitized_anchor_name.Create("This is also          a header"))
fmt.Println(sanitized_anchor_name.Create("main.go"))
fmt.Println(sanitized_anchor_name.Create("Article 123"))
fmt.Println(sanitized_anchor_name.Create("<- Let's try this, shall we?"))
fmt.Printf("%q\n", sanitized_anchor_name.Create("        "))
fmt.Println(sanitized_anchor_name.Create("Hello, 世界"))

Output:

this-is-a-header
this-is-also-a-header
main-go
article-123
let-s-try-this-shall-we
""
hello-世界

Package sanitized_anchor_name imports 1 packages (graph) and is imported by 21 packages. Updated 2017-02-13. Refresh now. Tools for package owners.