mirror of
https://github.com/Luzifer/mondash.git
synced 2024-11-10 08:30:02 +00:00
21 lines
652 B
Markdown
21 lines
652 B
Markdown
|
sanitized_anchor_name [![Build Status](https://travis-ci.org/shurcooL/sanitized_anchor_name.svg?branch=master)](https://travis-ci.org/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.
|
||
|
|
||
|
Example
|
||
|
=======
|
||
|
|
||
|
```Go
|
||
|
anchorName := sanitized_anchor_name.Create("This is a header")
|
||
|
|
||
|
fmt.Println(anchorName)
|
||
|
|
||
|
// Output:
|
||
|
// this-is-a-header
|
||
|
```
|