github.com/insionng/yougam@v0.0.0-20170714101924-2bc18d833463/libraries/shurcooL/sanitized_anchor_name/README.md (about)

     1  # 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)
     2  
     3  Package sanitized_anchor_name provides a func to create sanitized anchor names.
     4  
     5  Its logic can be reused by multiple packages to create interoperable anchor names and links to those anchors.
     6  
     7  At this time, it does not try to ensure that generated anchor names are unique, that responsibility falls on the caller.
     8  
     9  Installation
    10  ------------
    11  
    12  ```bash
    13  go get -u github.com/shurcooL/sanitized_anchor_name
    14  ```
    15  
    16  Example
    17  -------
    18  
    19  ```Go
    20  anchorName := sanitized_anchor_name.Create("This is a header")
    21  
    22  fmt.Println(anchorName)
    23  
    24  // Output:
    25  // this-is-a-header
    26  ```
    27  
    28  License
    29  -------
    30  
    31  - [MIT License](LICENSE)