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

Functions

func Create 

func Create(text string) string

Create returns a sanitized anchor name for the given text.

Example

Code:play  

package main

import (
	"fmt"

	"github.com/shurcooL/sanitized_anchor_name"
)

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

	fmt.Println(anchorName)

}

Output:

this-is-a-header
Example (Two)

Code:play  

package main

import (
	"fmt"

	"github.com/shurcooL/sanitized_anchor_name"
)

func main() {
	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-世界

Source Files

main.go

Version
v1.0.0 (latest)
Published
Dec 26, 2018
Platform
windows/amd64
Imports
1 packages
Last checked
6 days ago –

Tools for package owners.