Go Sitemap Generator 使用教程

Go Sitemap Generator 使用教程

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

1. 项目的目录结构及介绍

Go Sitemap Generator 项目的目录结构如下：

go-sitemap-generator/
├── LICENSE
├── README.md
├── go.mod
├── go.sum
├── stm/
│   ├── example_test.go
│   ├── sitemap.go
│   ├── sitemap_index.go
│   └── ...
└── ...

• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• go.mod 和 go.sum: Go 模块依赖管理文件。
• stm/: 核心功能目录，包含生成 sitemap 的主要代码。
  • example_test.go: 示例测试文件。
  • sitemap.go: 生成 sitemap 的主要逻辑文件。
  • sitemap_index.go: 生成 sitemap 索引的主要逻辑文件。

2. 项目的启动文件介绍

项目的启动文件位于 stm 目录下，主要文件是 sitemap.go。以下是启动文件的简要介绍：

package stm

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()
}

• stm.NewSitemap(1): 创建一个新的 sitemap 实例。
• sm.Create(): 初始化 sitemap。
• sm.Add(...): 添加 sitemap 条目。
• sm.Finalize(): 完成 sitemap 的生成。
• sm.PingSearchEngines(): 通知搜索引擎新的 sitemap。

3. 项目的配置文件介绍

项目的配置文件主要是 go.mod 和 go.sum，用于管理 Go 模块的依赖。以下是 go.mod 文件的示例内容：

module github.com/ikeikeikeike/go-sitemap-generator

go 1.16

require (
    github.com/clbanning/mxj v1.8.4
    // 其他依赖
)

• module: 定义模块路径。
• go: 指定 Go 版本。
• require: 列出项目依赖的模块及其版本。

go.sum 文件包含所有依赖模块的校验和，确保依赖的完整性和安全性。

以上是 Go Sitemap Generator 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。

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