1 sanitized_anchor_name

     2 =====================

     3 

     4 [![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)

     5 

     6 Package sanitized_anchor_name provides a func to create sanitized anchor names.

     7 

     8 Its logic can be reused by multiple packages to create interoperable anchor names

     9 and links to those anchors.

    10 

    11 At this time, it does not try to ensure that generated anchor names

    12 are unique, that responsibility falls on the caller.

    13 

    14 Installation

    15 ------------

    16 

    17 ```bash

    18 go get -u github.com/shurcooL/sanitized_anchor_name

    19 ```

    20 

    21 Example

    22 -------

    23 

    24 ```Go

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

    26 

    27 fmt.Println(anchorName)

    28 

    29 // Output:

    30 // this-is-a-header

    31 ```

    32 

    33 License

    34 -------

    35 

    36 -	[MIT License](LICENSE)