github
/
k3s
mirror of https://github.com/k3s-io/k3s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
k3s/vendor/github.com/shurcooL/sanitized_anchor_name
History
Darren Shepherd fa08d6076c Update vendor 2019-01-11 21:58:27 -07:00
..
.travis.yml Update vendor 2019-01-11 21:58:27 -07:00
LICENSE Update vendor 2019-01-11 21:58:27 -07:00
README.md Update vendor 2019-01-11 21:58:27 -07:00
main.go Update vendor 2019-01-11 21:58:27 -07:00

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