README

sanitized_anchor_name

Build Status GoDoc

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

go get -u github.com/shurcooL/sanitized_anchor_name

Example

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

fmt.Println(anchorName)

// Output:
// this-is-a-header

License

Documentation

Overview

    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.

    Index

    Examples

    Constants

    This section is empty.

    Variables

    This section is empty.

    Functions

    func Create

    func Create(text string) string

      Create returns a sanitized anchor name for the given text.

      Example
      Output:
      
      this-is-a-header
      
      Example (Two)
      Output:
      
      this-is-a-header
      this-is-also-a-header
      main-go
      article-123
      let-s-try-this-shall-we
      ""
      hello-世界
      

      Types

      This section is empty.

      Source Files