anchor

Documentation

Index

• type Anchor
  • func Anchors(body string) (anchs []Anchor, err error)

Types

type Anchor

type Anchor struct {
	ID          string `json:"id"`    // Id of the h* element.
	Value       string `json:"value"` // Value inside the anchor tag.
	HeaderLevel int    `json:"level"` // Level of the h* element.
}

Anchor is a html anchor tag with an id attribute and a value. Represents: <a id="Id">Value</a> It is intended to link to titles in the document

func Anchors

func Anchors(body string) (anchs []Anchor, err error)

Anchors finds <h*> elements inside a HTML string to create a list of anchors.