Sitemap 项目技术文档

1. 安装指南

Sitemap 是一个基于 Ruby on Rails 的简单站点地图生成器。您可以通过以下方式安装该宝石：

gem install sitemap

或者作为一个插件：

rails plugin install git://github.com/viseztrance/rails-sitemap.git

安装后，创建初始配置文件：

rails g sitemap:install

2. 项目使用说明

在站点地图配置文件中，路径可以以下列方式索引：

Sitemap::Generator.instance.load :host => "mywebsite.com" do
  path :root, :priority => 1
  path :faq, :priority => 0.5, :change_frequency => "weekly"
  literal "/my_blog" # 用于虚拟 URL 层叠搜索结果
  resources :activities, :params => { :format => "html" }
  resources :articles, :objects => proc { Article.published }
  # 添加 ResourceSync 元素示例
  literal "/files/6t053f96k", metadata: { hash: "md5:1584abdf8ebdc9802ac0c6a7402c03b6", length: "8876", type: "text/html" }
end

构建站点地图：

rake sitemap:generate

默认情况下，站点地图保存在当前应用程序根路径。您可以通过传递一个位置环境变量或使用配置选项来更改保存路径：

Sitemap.configure do |config|
  config.save_path = "/home/user/apps/my-app/shared"
end

向搜索引擎发送 Ping 请求：

rake sitemap:ping

3. 项目API使用文档

设置默认值：

您可以更改 params 或 search 选项的默认值，如下所示：

Sitemap.configure do |config|
  config.params_format = "html"
  config.search_change_frequency = "monthly"
end

对于大型网站：

Google 对每个站点地图的条目数限制为 50,000，最大大小为 10 MB。为了遵守这些规则，拥有超过 10,000 个 URL 的站点地图会被拆分为多个文件。您可以通过覆盖最大 URL 值来更改此设置：

Sitemap.configure do |config|
  config.max_urls = 50000
end

4. 项目安装方式

本项目使用 minitest 进行测试。要运行测试，只需执行以下命令：

rake

项目遵循 MIT 许可证和/或知识共享署名-相同方式共享许可证。