Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sabloger/sitemap-generator
An awesome Go Sitemap generator module
https://github.com/sabloger/sitemap-generator
go golang sitemap sitemap-builder sitemap-generator sitemap-xml xml
Last synced: 2 months ago
JSON representation
An awesome Go Sitemap generator module
- Host: GitHub
- URL: https://github.com/sabloger/sitemap-generator
- Owner: sabloger
- License: mit
- Created: 2022-02-09T12:02:26.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-02T07:57:32.000Z (9 months ago)
- Last Synced: 2024-06-19T23:12:23.857Z (7 months ago)
- Topics: go, golang, sitemap, sitemap-builder, sitemap-generator, sitemap-xml, xml
- Language: Go
- Homepage:
- Size: 70.3 KB
- Stars: 32
- Watchers: 3
- Forks: 10
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
sitemap-generator
=================
[](https://godoc.org/github.com/sabloger/sitemap-generator)
[](https://goreportcard.com/report/github.com/sabloger/sitemap-generator)
A high-performance sitemap-generator Go module which is a comprehensive tool to create
and manage sitemap_index and sitemap files in a beautiful way. :)
Please see http://www.sitemaps.org/ for description of sitemap contents.
## Installation
Use `go get`:
`go get github.com/sabloger/sitemap-generator`
# How to Use sitemap-generator
You can use the module in either Single-file sitemap or Multiple-files
sitemaps with a sitemap_index file.
### Single sitemap usage
```go
package main
import (
"fmt"
"github.com/sabloger/sitemap-generator/smg"
"log"
"time"
)
func main() {
now := time.Now().UTC()
sm := smg.NewSitemap(true) // The argument is PrettyPrint which must be set on initializing
sm.SetName("single_sitemap") // Optional
sm.SetHostname("https://www.example.com")
sm.SetOutputPath("./some/path")
sm.SetLastMod(&now)
sm.SetCompress(false) // Default is true
sm.SetMaxURLsCount(25000) // Default maximum number of URLs in each file is 50,000 to break
// Adding URL items
err := sm.Add(&smg.SitemapLoc{
Loc: "some/uri.html",
LastMod: &now,
ChangeFreq: smg.Always,
Priority: 0.4,
Images: []*SitemapImage{{"/path-to-image.jpg"}, {"/path-to-image-2.jpg"}},
})
if err != nil {
log.Fatal("Unable to add SitemapLoc:", err)
}
// Save func saves the xml files and returns more than one filename in case of split large files.
filenames, err := sm.Save()
if err != nil {
log.Fatal("Unable to Save Sitemap:", err)
}
for i, filename := range filenames {
fmt.Println("file no.", i+1, filename)
}
}
```
`single_sitemap.xml` will look like:
```xml
https://www.example.com/some/uri.html
2022-02-12T16:29:46.45013Z
always
0.4
https://www.example.com/path-to-image.jpg
https://www.example.com/path-to-image-2.jpg
```
### SitemapIndex usage
```go
package main
import (
"fmt"
"github.com/sabloger/sitemap-generator/smg"
"log"
"time"
)
func main() {
now := time.Now().UTC()
smi := smg.NewSitemapIndex(true)
smi.SetCompress(false)
smi.SetSitemapIndexName("an_optional_name_for_sitemap_index")
smi.SetHostname("https://www.example.com")
smi.SetOutputPath("./sitemap_index_example/")
smi.SetServerURI("/sitemaps/") // Optional
smBlog := smi.NewSitemap()
smBlog.SetName("blog_sitemap")
smBlog.SetLastMod(&now)
err := smBlog.Add(&smg.SitemapLoc{
Loc: "blog/post/1231",
LastMod: &now,
ChangeFreq: smg.Weekly,
Priority: 0.8,
})
if err != nil {
log.Fatal("Unable to add SitemapLoc:", err)
}
smNews := smi.NewSitemap()
smNews.SetLastMod(&now)
err = smNews.Add(&smg.SitemapLoc{
Loc: "news/2021-01-05/a-news-page",
LastMod: &now,
ChangeFreq: smg.Weekly,
Priority: 1,
})
if err != nil {
log.Fatal("Unable to add SitemapLoc:", err)
}
filename, err := smi.Save()
if err != nil {
log.Fatal("Unable to Save Sitemap:", err)
}
// Pings the Search engines. default Google and Bing, But you can add any other ping URL's
// in this format: http://www.google.com/webmasters/tools/ping?sitemap=%s
smi.PingSearchEngines()
fmt.Println("sitemap_index file:", filename)
}
```
the output directory will be like this:
```
sitemap_index_example
├── an_optional_name_for_sitemap_index.xml
├── blog_sitemap.xml
└── sitemap2.xml
```
`an_optional_name_for_sitemap_index.xml` will look like:
```xml
https:/www.example.com/sitemaps/blog_sitemap.xml
2022-02-12T18:38:06.671183Z
https:/www.example.com/sitemaps/sitemap2.xml
2022-02-12T18:38:06.671183Z
```
### Custom output buffer for Sitemap files
It is possible to write the `Sitemap` content into a custom output using this method:
```go
// Finalize must be called to make the content closed.
sm.Finalize()
// Needs an io.Writer interface
buf := bytes.Buffer{}
n, err = sm.WriteTo(&buf)
```
## TODO list
- [x] Develop: add new functionalities:
- [x] Write the sitemap_index and sitemap files in xml format
- [x] Compress option
- [x] Break the sitemap xml file in case of exceeding
the sitemaps.org limits (50,000 urls OR 50MB uncompressed file)
- [x] Ability to set Sitemap uri on server to set on it's url in sitemap_index file
- [x] Ping search engines for sitemap_index
- [ ] Ping search engines for single sitemap
- [ ] Break the sitemap_index xml file in case of exceeding the sitemaps.org limits (50,000 urls OR 50MB uncompressed file)
- [x] Implement Sitemap.WriteTo for custom outputs.
- [ ] Implement SitemapIndex.WriteTo for custom outputs.
- [x] Ability to change maximum URLs number for each file.
- [ ] Support: Additional content types:
- [ ] Video sitemaps
- [x] Image sitemaps
- [ ] News sitemaps
- [ ] Alternate Links
- [ ] Module Stability:
- [x] Increase test coverage to more than %80. current coverage is: 86.3% of statements
- [x] Write tests for different usages.
## LINKS
GoDoc documentation:
https://pkg.go.dev/github.com/sabloger/sitemap-generator
Git repository:
https://github.com/sabloger/sitemap-generator
## License
MIT