golazy.dev
–
golazy.dev
/
lazyseo
Index
|
Files
|
Directories
package lazyseo
import "golazy.dev/lazyseo"Variables
var (
WebPage = PageKind{OpenGraph: "website", Schema: "WebPage"}
WebSite = PageKind{OpenGraph: "website", Schema: "WebSite"}
Article = PageKind{OpenGraph: "article", Schema: "Article"}
BlogPosting = PageKind{OpenGraph: "article", Schema: "BlogPosting"}
NewsArticle = PageKind{OpenGraph: "article", Schema: "NewsArticle"}
Product = PageKind{OpenGraph: "product", Schema: "Product"}
Profile = PageKind{OpenGraph: "profile", Schema: "ProfilePage"}
Book = PageKind{OpenGraph: "book", Schema: "Book"}
Video = PageKind{OpenGraph: "video.other", Schema: "VideoObject"}
MusicSong = PageKind{OpenGraph: "music.song", Schema: "MusicRecording"}
MusicAlbum = PageKind{OpenGraph: "music.album", Schema: "MusicAlbum"}
Place = PageKind{OpenGraph: "place", Schema: "Place"}
Restaurant = PageKind{OpenGraph: "place", Schema: "Restaurant"}
Organization = PageKind{OpenGraph: "website", Schema: "Organization"}
)Functions
func DefaultJSONLD
DefaultJSONLD builds a conventional schema.org value from metadata.
func DefaultJSONLD(meta Meta) anyfunc Helpers
Helpers returns the template helpers provided by lazyseo.
func Helpers(defaults ...Option) map[string]anyTypes
type Alternate
Alternate describes an alternate URL for the current page.
type Alternate struct {
Language string
URL string
Media string
Type string
Title string
}type Meta
Meta contains the metadata emitted by the seo view helper.
type Meta struct {
Title string
SiteName string
Description string
Author string
Language string
URL string
Canonical string
Alternates []Alternate
Image string
ImageAlt string
OpenGraph OpenGraph
Type string
SchemaType string
Locale string
Twitter TwitterCard
TwitterType string
JSONLD []any
PublishedTime time.Time
UpdatedTime time.Time
}func New
New builds Meta with the supplied options.
func New(options ...Option) *Metafunc Set
Set stores request-local SEO metadata on a controller.
func Set(controller setter, options ...Option) *Metatype OpenGraph
OpenGraph overrides metadata emitted for Open Graph tags.
type OpenGraph struct {
Title string
Description string
URL string
Image string
ImageAlt string
ImageWidth int
ImageHeight int
Type string
SiteName string
Locale string
}type Option
Option configures Meta values.
type Option func(*Meta)func AlternateLink
func AlternateLink(alternate Alternate) Optionfunc AlternateURL
func AlternateURL(language, url string) Optionfunc Author
func Author(value string) Optionfunc Canonical
func Canonical(value string) Optionfunc Description
func Description(value string) Optionfunc Image
func Image(value string) Optionfunc ImageAlt
func ImageAlt(value string) Optionfunc JSONLD
func JSONLD(value any) Optionfunc Kind
func Kind(kind PageKind) Optionfunc Language
func Language(value string) Optionfunc LastUpdated
func LastUpdated(value time.Time) Optionfunc Locale
func Locale(value string) Optionfunc OpenGraphData
func OpenGraphData(value OpenGraph) Optionfunc OpenGraphType
func OpenGraphType(value string) Optionfunc PublishedTime
func PublishedTime(value time.Time) Optionfunc SchemaType
func SchemaType(value string) Optionfunc SiteName
func SiteName(value string) Optionfunc Title
func Title(value string) Optionfunc TwitterCardData
func TwitterCardData(value TwitterCard) Optionfunc TwitterCardType
func TwitterCardType(value string) Optionfunc Type
func Type(value string) Optionfunc URL
func URL(value string) Optionfunc UpdatedTime
func UpdatedTime(value time.Time) Optiontype PageKind
PageKind is a common page/content kind that maps to Open Graph and JSON-LD.
type PageKind struct {
OpenGraph string
Schema string
}type TwitterCard
TwitterCard overrides metadata emitted for Twitter card tags.
type TwitterCard struct {
Card string
Title string
Description string
Image string
ImageAlt string
Site string
Creator string
}Directories
| Path | Synopsis |
|---|---|
| lazyseo/jsonld | Package jsonld provides small schema.org JSON-LD value types for lazyseo. |
Package lazyseo renders common document metadata for GoLazy views.
lazyapp installs the standard SEO helpers when a renderer is configured, and lazycontroller.Base exposes convenience methods for setting page metadata from controller actions. Use those integrations in normal applications.
The package can also be used directly with any value that supports Set(string, any), which keeps metadata rendering independent from controller internals and from a specific template engine.