githaven/vendor/github.com/shurcooL/sanitized_anchor_name
2016-11-04 08:43:11 +01:00
..
LICENSE Added all required dependencies 2016-11-04 08:43:11 +01:00
main.go Added all required dependencies 2016-11-04 08:43:11 +01:00
README.md Added all required dependencies 2016-11-04 08:43:11 +01:00

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