jsonld

Documentation

Index

• type Breadcrumb
• type ItemList
  • func BreadcrumbList[T Breadcrumb](urlprefix string, breadcrumbs []T) ItemList
• type ItemListElement

Types

type Breadcrumb

type Breadcrumb interface {
	Name() string
	URLPath() string
}

type ItemList

type ItemList struct {
	Context  string            `json:"@context"`
	Type     string            `json:"@type"`
	Elements []ItemListElement `json:"itemListElement"`
}

func BreadcrumbList

func BreadcrumbList[T Breadcrumb](urlprefix string, breadcrumbs []T) ItemList

See https://developers.google.com/search/docs/appearance/structured-data/breadcrumb

BreadcrumbList uses generics so we don't have to convert the slice from []SomeType to []Breadcrumb.

type ItemListElement

type ItemListElement struct {
	Type     string `json:"@type"`
	Position int    `json:"position"` // starting with 1
	Name     string `json:"name"`
	Item     string `json:"item,omitempty"` // URL
}