mirror of https://github.com/k3s-io/k3s
37 lines
930 B
Markdown
37 lines
930 B
Markdown
|
sanitized_anchor_name
|
||
|
|
=====================
|
||
|
|
|
||
|
|
[](https://travis-ci.org/shurcooL/sanitized_anchor_name) [](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)
|