DockerCLI/vendor/github.com/shurcooL/sanitized_anchor_name
Daniel Nephin 875daf0130 Add missing dependencies to vendor, and fix generation imports
Signed-off-by: Daniel Nephin <dnephin@docker.com>
2017-06-02 11:12:43 -04:00
..
LICENSE Add missing dependencies to vendor, and fix generation imports 2017-06-02 11:12:43 -04:00
README.md Add missing dependencies to vendor, and fix generation imports 2017-06-02 11:12:43 -04:00
main.go Add missing dependencies to vendor, and fix generation imports 2017-06-02 11:12:43 -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