Go Sitemap Generator 项目教程

Go Sitemap Generator 项目教程

go-sitemap-generator go-sitemap-generator is the easiest way to generate Sitemaps in Go 项目地址: https://gitcode.com/gh_mirrors/go/go-sitemap-generator

1. 项目目录结构及介绍

go-sitemap-generator/
├── .gitignore
├── .travis.yml
├── LICENSE
├── README.md
├── go.mod
├── go.sum
└── stm/
    ├── adapter.go
    ├── builder.go
    ├── sitemap.go
    └── ...

• .gitignore: 用于指定Git版本控制系统忽略的文件和目录。
• .travis.yml: Travis CI 的配置文件，用于持续集成。
• LICENSE: 项目的开源许可证文件，本项目使用MIT许可证。
• README.md: 项目的介绍文档，包含项目的基本信息、安装方法、使用示例等。
• go.mod: Go模块的依赖管理文件。
• go.sum: Go模块的依赖校验文件。
• stm/: 项目的主要代码目录，包含生成Sitemap的核心逻辑。

2. 项目的启动文件介绍

项目的启动文件通常是 main.go，但在本项目中，启动文件是一个示例文件，展示了如何使用 go-sitemap-generator 生成Sitemap。以下是一个简单的启动文件示例：

package main

import (
    "github.com/ikeikeikeike/go-sitemap-generator/v2/stm"
)

func main() {
    sm := stm.NewSitemap(1)
    sm.Create()

    sm.Add(stm.URL{
        {"loc", "home"},
        {"changefreq", "always"},
        {"mobile", true},
    })

    sm.Add(stm.URL{
        {"loc", "readme"},
    })

    sm.Add(stm.URL{
        {"loc", "aboutme"},
        {"priority", 0.1},
    })

    sm.Finalize()
    sm.PingSearchEngines()
}

在这个示例中，main 函数首先创建了一个新的Sitemap实例，然后添加了几个URL条目，最后生成了Sitemap并通知搜索引擎。

3. 项目的配置文件介绍

本项目没有传统的配置文件，但可以通过代码中的选项来配置Sitemap生成器的行为。以下是一些常用的配置选项：

sm.SetDefaultHost("http://www.example.com")
sm.SetSitemapsHost("http://s3.amazonaws.com/sitemap-generator/")
sm.SetPublicPath("tmp/")
sm.SetSitemapsPath("sitemaps/")
sm.SetAdapter(&stm.S3Adapter{
    Region: "ap-northeast-1",
    Bucket: "your-bucket",
    ACL: "public-read",
})
sm.SetFilename("new_filename")

• SetDefaultHost: 设置网站的默认主机名。
• SetSitemapsHost: 设置Sitemap文件的远程主机。
• SetPublicPath: 设置本地存储Sitemap文件的目录。
• SetSitemapsPath: 设置Sitemap文件的存储路径。
• SetAdapter: 设置Sitemap文件的存储适配器，例如S3适配器。
• SetFilename: 设置生成的Sitemap文件的名称。

通过这些配置选项，可以灵活地控制Sitemap生成器的行为，以满足不同的需求。

go-sitemap-generator go-sitemap-generator is the easiest way to generate Sitemaps in Go 项目地址: https://gitcode.com/gh_mirrors/go/go-sitemap-generator