sitemap

README

go-sitemap-generator

go-sitemap-generator A sitemap generator in Go. It can generate a sitemap in XML format.

English | 中文简体

Installation

go get github.com/chenmingyong0423/go-sitemap-generator

Usage

err := NewSitemap().
    Url(
        "https://xxx.cn/posts/1",
        WithLastMod("2024-05-17"),
        WithChangeFreq("weekly"),
        WithPriority(1.0),
    ).
    Url("https://xxx.cn/posts/2").Output("sitemap.xml").
    GenerateXml()

Documentation

Index

• type Sitemap
  • func NewSitemap() *Sitemap
  • func (s *Sitemap) GenerateXml() error
  • func (s *Sitemap) Output(value string) *Sitemap
  • func (s *Sitemap) Url(loc string, opts ...URLOption) *Sitemap
  • func (s *Sitemap) Xmlns(value string) *Sitemap
  • func (s *Sitemap) XmlnsImage(value string) *Sitemap
• type URL
  • func NewURL(loc string, opts ...URLOption) *URL
• type URLOption
  • func WithChangeFreq(changeFreq string) URLOption
  • func WithImage(image *UrlImage) URLOption
  • func WithLastMod(lastMod string) URLOption
  • func WithPriority(priority float64) URLOption
• type UrlImage
  • func NewUrlImage(ioc string) *UrlImage
• type UrlSet
  • func (urlSet *UrlSet) Marshal() ([]byte, error)

Types

type Sitemap

type Sitemap struct {
	UrlSet UrlSet
	// contains filtered or unexported fields
}

func NewSitemap

func NewSitemap() *Sitemap

NewSitemap creates a new Sitemap the xmlns is defaulted to https://www.sitemaps.org/schemas/sitemap/0.9 you can change it by calling Sitemap.Xmlns Method

func (*Sitemap) GenerateXml

func (s *Sitemap) GenerateXml() error

func (*Sitemap) Output

func (s *Sitemap) Output(value string) *Sitemap

func (*Sitemap) Url

func (s *Sitemap) Url(loc string, opts ...URLOption) *Sitemap

func (*Sitemap) Xmlns

func (s *Sitemap) Xmlns(value string) *Sitemap

func (*Sitemap) XmlnsImage

func (s *Sitemap) XmlnsImage(value string) *Sitemap

type URL

type URL struct {
	Loc        string    `xml:"loc" opt:"-"`
	LastMod    string    `xml:"lastmod,omitempty"`
	ChangeFreq string    `xml:"changefreq,omitempty"`
	Priority   float64   `xml:"priority,omitempty"`
	Image      *UrlImage `xml:"image:image,omitempty"`
}

func NewURL

func NewURL(loc string, opts ...URLOption) *URL

type URLOption

type URLOption func(*URL)

func WithChangeFreq

func WithChangeFreq(changeFreq string) URLOption

func WithImage

func WithImage(image *UrlImage) URLOption

func WithLastMod

func WithLastMod(lastMod string) URLOption

func WithPriority

func WithPriority(priority float64) URLOption

type UrlImage

type UrlImage struct {
	Loc string `xml:"image:loc"`
}

func NewUrlImage

func NewUrlImage(ioc string) *UrlImage

type UrlSet

type UrlSet struct {
	XMLName    xml.Name `xml:"urlset"`
	Xmlns      string   `xml:"xmlns,attr"`
	XmlnsImage string   `xml:"xmlns:image,attr"`
	Urls       []URL    `xml:"url"`
}

func (*UrlSet) Marshal

func (urlSet *UrlSet) Marshal() ([]byte, error)