k3s/vendor/github.com/shurcooL/sanitized_anchor_name
Erik Wilson 4e6ed0873f Update vendor for k8s 1.17.0 2019-12-15 23:28:25 -07:00
..
.travis.yml Update vendor for k8s 1.17.0 2019-12-15 23:28:25 -07:00
LICENSE Update vendor for k8s 1.17.0 2019-12-15 23:28:25 -07:00
README.md Update vendor for k8s 1.17.0 2019-12-15 23:28:25 -07:00
go.mod Update vendor for k8s 1.17.0 2019-12-15 23:28:25 -07:00
main.go Update vendor for k8s 1.17.0 2019-12-15 23:28:25 -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