Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A simple ruby on rails sitemap generator
Ruby
tag: v0.1

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
test
.gitignore
LICENSE
README.rdoc
Rakefile
sitemap.gemspec

README.rdoc

Sitemap

A simple ruby on rails sitemap generator.

Instalation

Install the gem:

gem install sitemap

Or as a plugin:

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

Then create the initial config file:

rails g sitemap:install

Usage

In your sitemap config file, paths can be indexed as follows:

Sitemap::Generator.instance.load :host => "mywebsite.com" do
  path :root, :priority => 1
  path :faq, :priority => 0.5, :change_frequency => "weekly"
  resources :activities, :params => { :format => "html" }
  resources :articles, :objects => proc { Article.published }
end

Please read the docs for a more comprehensive list of options.

Building the sitemap:

rake sitemap:generate

Ping search engines:

rake sitemap:ping

Setting defaults

You may change the defaults for either params or search options as follows:

Sitemap.defaults[:params] = { :format => "html" }

Limitations

Sitemaps can only have up to 50000 urls and an uncompressed size of 10MB. This issue will be resolved in a future release.

License

This package is licensed under the MIT license and/or the Creative Commons Attribution-ShareAlike.

Something went wrong with that request. Please try again.