sanitized_anchor_name

README

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.

Installation

go get -u github.com/shurcooL/sanitized_anchor_name

Example

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

fmt.Println(anchorName)

// Output:
// this-is-a-header

License

• MIT License

Documentation

Overview

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

• func Create(text string) string

Examples

• Create

Functions

func Create

func Create(text string) string

Create returns a sanitized anchor name for the given text.

Example

package main

import (
	"fmt"

	"github.com/coreos/etcd/Godeps/_workspace/src/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