perkeep/vendor/github.com/shurcooL/sanitized_anchor_name
Brad Fitzpatrick 75d60962f6 Move remaining stuff in third_party/* to vendor/*
Change-Id: Ifbcc02817083cba68d8c1acec3e6ec50e8f61149
2016-04-20 16:49:15 -07:00
..
README.md Move remaining stuff in third_party/* to vendor/* 2016-04-20 16:49:15 -07:00
main.go Move remaining stuff in third_party/* to vendor/* 2016-04-20 16:49:15 -07:00
main_test.go Move remaining stuff in third_party/* to vendor/* 2016-04-20 16:49:15 -07:00

README.md

sanitized_anchor_name Build Status

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.

Example

anchorName := sanitized_anchor_name.Create("This is a header")

fmt.Println(anchorName)

// Output:
// this-is-a-header

License