kops/vendor/github.com/shurcooL/sanitized_anchor_name
chrislovecnm 609e268a1d gazelle updates with new bazel version 2017-11-05 17:41:53 -07:00
..
.travis.yml Update vendor 2017-03-16 02:40:45 -04:00
BUILD.bazel gazelle updates with new bazel version 2017-11-05 17:41:53 -07:00
LICENSE Added go-md2man, blackfriday and sanitized_anchor_name deps 2016-11-05 18:13:23 +00:00
README.md Update vendor 2017-03-16 02:40:45 -04:00
main.go Added go-md2man, blackfriday and sanitized_anchor_name deps 2016-11-05 18:13:23 +00:00
main_test.go Update vendor 2017-03-16 02:40:45 -04: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