kops/vendor/github.com/shurcooL/sanitized_anchor_name
Brandon Wagner fe3671fff5 go.mod deps for feat toolbox instance-selector 2020-08-10 16:16:51 -05:00
..
.travis.yml go.mod deps for feat toolbox instance-selector 2020-08-10 16:16:51 -05:00
BUILD.bazel go.mod deps for feat toolbox instance-selector 2020-08-10 16:16:51 -05:00
LICENSE go.mod deps for feat toolbox instance-selector 2020-08-10 16:16:51 -05:00
README.md go.mod deps for feat toolbox instance-selector 2020-08-10 16:16:51 -05:00
go.mod go.mod deps for feat toolbox instance-selector 2020-08-10 16:16:51 -05:00
main.go go.mod deps for feat toolbox instance-selector 2020-08-10 16:16:51 -05: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