sitemapper

Sitemapper helps you to generate sitemaps for your website. It generates sitemap compliant XML, and gives you the flexibility to handle what is generated, and where you place your sitemaps.

Installation

Add this to your application's shard.yml:

dependencies:
  sitemapper:
    github: jwoertink/sitemapper

Usage

require "sitemapper"

# Configure sitemapper
Sitemapper.config do |c|
  # Generate a sitemap_index file
  c.use_index = true # default false

  c.host = "https://yoursite.io"

  # The max number of <url> elements to add to each sitemap
  c.max_urls = 20 # default 500 
end

# Use sitemapper
sitemaps = Sitemapper.build do
  add("/about", changefreq: "yearly", priority: 0.1)
  add("/profiles/somedude", changefreq: "always", priority: 0.9)
end

# Do whatever you want with these. 
# Maybe upload to S3, or write to a file
puts typeof(sitemaps) #=> Array(Hash(String, String))
puts sitemaps.first #=> {"name" => "sitemap1.xml", "data" => "<?xml ..."}

# Just have Sitemapper write them out to your public/sitemaps folder
# This will create ./public/sitemapes/sitemap1.xml, etc...
Sitemapper.store(sitemaps, "./public/sitesmaps")

You can also pass options to build.

Sitemapper.build(host: "your host", max_urls: 20, use_index: true) do
  add("/whatever", lastmod: Time.now)
end

Adding videos to your sitemap

You can add in video information which will generate the necessary XML for videos. Check out the docs for all the different options you can use.

Sitemapper uses a Sitemapper::VideoMap object for building out video sitemap data. Pretty much the attributes all map 1 to 1 except for tag. Use the plural tags as an array.

video = Sitemapper::VideoMap.new(thumbnail_loc: "http://video.org/sample.mpg", title: "Video", description: "This is a video", tags: ["one", "two"])
sitemaps = Sitemapper.build do
  add("/videos/123", video: video, changefreq: "yearly")
end

Same goes for in you want to add an image. Use Sitemapper::ImageMap and pass add("/image/1", image: image). Read up more on image sitemaps here.

Saving your XML

Sitemapper gives you the raw XML in strings. This gives you the option to save that data however you wish. Maybe you're crazy and want to store it in your DB? Maybe you're running on Heroku and can't just write locally, so you need to ship it off to AWS. What ever the case, you have that freedom.

If you just need to store it locally, you can use

Sitemapper.store(sitemaps, "./path/to/save")

One thing to note about where you store your sitemaps. The sitemap index will point to domain.com/sitemapX.xml if you store your sitemaps in a nested folder, you may need to do some fancy rewrites to make this url accessible.

Development

Nothing fancy. Just pull down the repo, add code and make sure specs are passing.

Contributing

  1. Fork it ( https://github.com/jwoertink/sitemapper/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Add some specs and run crystal spec/
  4. Commit your changes (git commit -am 'Add some feature')
  5. Push to the branch (git push origin my-new-feature)
  6. Create a new Pull Request

Contributors