2016-03-27 18:46:08 +00:00
|
|
|
# sanitized_anchor_name [](https://travis-ci.org/shurcooL/sanitized_anchor_name) [](https://godoc.org/github.com/shurcooL/sanitized_anchor_name)
|
2016-01-23 12:07:07 +00:00
|
|
|
|
2016-03-27 18:46:08 +00:00
|
|
|
Package sanitized_anchor_name provides a func to create sanitized anchor names.
|
2016-01-23 12:07:07 +00:00
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
2016-03-27 18:46:08 +00:00
|
|
|
Installation
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
go get -u github.com/shurcooL/sanitized_anchor_name
|
|
|
|
|
```
|
|
|
|
|
|
2016-01-23 12:07:07 +00:00
|
|
|
Example
|
2016-03-27 18:46:08 +00:00
|
|
|
-------
|
2016-01-23 12:07:07 +00:00
|
|
|
|
|
|
|
|
```Go
|
|
|
|
|
anchorName := sanitized_anchor_name.Create("This is a header")
|
|
|
|
|
|
|
|
|
|
fmt.Println(anchorName)
|
|
|
|
|
|
|
|
|
|
// Output:
|
|
|
|
|
// this-is-a-header
|
|
|
|
|
```
|
2016-03-27 18:46:08 +00:00
|
|
|
|
|
|
|
|
License
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
- [MIT License](http://opensource.org/licenses/mit-license.php)
|
