k3s/vendor/github.com/shurcooL/sanitized_anchor_name
Jeff Grafton aee5f457db update BUILD files 2017-10-15 18:18:13 -07:00
..
.travis.yml
BUILD update BUILD files 2017-10-15 18:18:13 -07:00
LICENSE
README.md
main.go

README.md

sanitized_anchor_name Build Status GoDoc

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