buildkit/vendor/github.com/shurcooL/sanitized_anchor_name
Tonis Tiigi 2d18f3a923 gomod: update to go1.17
Signed-off-by: Tonis Tiigi <tonistiigi@gmail.com>
2021-08-16 20:00:00 -07:00
..
.travis.yml vendor: update containerd (and various packages) 2020-02-28 10:24:10 +09:00
LICENSE vendor: update containerd (and various packages) 2020-02-28 10:24:10 +09:00
README.md vendor: update containerd (and various packages) 2020-02-28 10:24:10 +09:00
main.go vendor: update containerd (and various packages) 2020-02-28 10:24:10 +09: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