View Source Sitemapper (Sitemapper v0.9.0)

Sitemapper is an Elixir library for generating XML Sitemaps.

It's designed to generate large sitemaps while maintaining a low memory profile. It can persist sitemaps to Amazon S3, disk or any other adapter you wish to write.

Summary

Functions

generate(enum, opts)

Receives a Stream of Sitemapper.URL and returns a Stream of {filename, body} tuples, representing the individual sitemap XML files, followed by an index XML file.

persist(enum, opts)

Receives a Stream of {filename, body} tuples, and persists those to the Sitemapper.Store.

Functions

Link to this function

generate(enum, opts)

View Source 
@spec generate(stream :: Enumerable.t(), opts :: keyword()) :: Enumerable.t()

Receives a Stream of Sitemapper.URL and returns a Stream of {filename, body} tuples, representing the individual sitemap XML files, followed by an index XML file.

Configuration:

Accepts the following Keyword options in opts:

  • :sitemap_url (required) - The base URL where the generated sitemap files will live. e.g. http://example.org, if your sitemap lives at http://example.org/sitemap.xml
  • :gzip (default: true) - Sets whether the files are gzipped
  • :name - An optional suffix for the sitemap filename. e.g. If you set to news, will produce sitemap-news.xml.gz and sitemap-news-00001.xml.gz filenames.
  • :index_lastmod (default: Date.utc_today()) - An optional Date/DateTime/NaiveDateTime for the lastmod element in the index.
Link to this function

persist(enum, opts)

View Source 
@spec persist(
  Enumerable.t(),
  keyword()
) :: Enumerable.t()

Receives a Stream of {filename, body} tuples, and persists those to the Sitemapper.Store.

Will raise if persistence fails.

Configuration:

Accepts the following Keyword options in opts: