sanitized_anchor_name

package
v2.3.8+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 16, 2017 License: MIT, Apache-2.0 Imports: 1 Imported by: 0

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
package main

import (
	"fmt"

	"github.com/coreos/etcd/Godeps/_workspace/src/github.com/shurcooL/sanitized_anchor_name"
)

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

	fmt.Println(anchorName)

}
Output:

this-is-a-header

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL