sitemap

package module

v0.2.2 Latest Latest Go to latest Published: Sep 26, 2018 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ketabchi/go-sitemap

Links

Open Source Insights

README ¶

go-sitemap

go-sitemap get sitemap.xml (or sitemapindex.xml) and generate Sitemap object.

Installation

go get github.com/yterajima/go-sitemap

Usage

See example.

Documentation ¶

Index ¶

func SetFetch(f func(URL string, options interface{}) ([]byte, error))
func SetInterval(time time.Duration)
type Index
- func ParseIndex(data []byte) (idx Index, err error)
type Sitemap
- func Get(URL string, options interface{}) (Sitemap, error)
- func Parse(data []byte) (smap Sitemap, err error)
type URL

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func SetFetch ¶

func SetFetch(f func(URL string, options interface{}) ([]byte, error))

SetFetch change fetch closure

func SetInterval ¶

func SetInterval(time time.Duration)

SetInterval change Time interval to be used in Index.get

Types ¶

type Index ¶

type Index struct {
	XMLName xml.Name `xml:"sitemapindex"`
	Sitemap []parts  `xml:"sitemap"`
}

Index is a structure of <sitemapindex>

func ParseIndex ¶

func ParseIndex(data []byte) (idx Index, err error)

ParseIndex create Index data from text

type Sitemap ¶

type Sitemap struct {
	XMLName xml.Name `xml:"urlset"`
	URL     []URL    `xml:"url"`
}

Sitemap is a structure of <sitemap>

func Get ¶

func Get(URL string, options interface{}) (Sitemap, error)

Get sitemap data from URL

func Parse ¶

func Parse(data []byte) (smap Sitemap, err error)

Parse create Sitemap data from text

type URL ¶

type URL struct {
	Loc        string  `xml:"loc"`
	LastMod    string  `xml:"lastmod"`
	ChangeFreq string  `xml:"changefreq"`
	Priority   float32 `xml:"priority"`
}

URL is a structure of <url> in <sitemap>

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
_example
custom_fetch
simple

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