diff options
author | Tulir Asokan <tulir@maunium.net> | 2018-04-22 21:25:06 +0300 |
---|---|---|
committer | Tulir Asokan <tulir@maunium.net> | 2018-04-22 21:25:51 +0300 |
commit | 64fa922ec013079f8f0c90fc9e93c56db3611d30 (patch) | |
tree | 7bb9b40f57b8368ef0f5eeccea02d80e54796927 /vendor/github.com/shurcooL/sanitized_anchor_name/README.md | |
parent | bfb5f0dd457be326b1ae7638a64d2e79cbace371 (diff) |
Switch to dep
Diffstat (limited to 'vendor/github.com/shurcooL/sanitized_anchor_name/README.md')
-rw-r--r-- | vendor/github.com/shurcooL/sanitized_anchor_name/README.md | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/vendor/github.com/shurcooL/sanitized_anchor_name/README.md b/vendor/github.com/shurcooL/sanitized_anchor_name/README.md new file mode 100644 index 0000000..670bf0f --- /dev/null +++ b/vendor/github.com/shurcooL/sanitized_anchor_name/README.md @@ -0,0 +1,36 @@ +sanitized_anchor_name +===================== + +[![Build Status](https://travis-ci.org/shurcooL/sanitized_anchor_name.svg?branch=master)](https://travis-ci.org/shurcooL/sanitized_anchor_name) [![GoDoc](https://godoc.org/github.com/shurcooL/sanitized_anchor_name?status.svg)](https://godoc.org/github.com/shurcooL/sanitized_anchor_name) + +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 +------------ + +```bash +go get -u github.com/shurcooL/sanitized_anchor_name +``` + +Example +------- + +```Go +anchorName := sanitized_anchor_name.Create("This is a header") + +fmt.Println(anchorName) + +// Output: +// this-is-a-header +``` + +License +------- + +- [MIT License](LICENSE) |