Sitemapper v0.2.0 Sitemapper View Source

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.

Link to this section 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.

ping(enum, opts)

Receives a Stream of {filename, body} tuples, takes the last one (the index file), and pings Google and Bing with its URL.

Link to this section Functions

generate(enum, opts)

generate(stream :: Enumerable.t(), opts :: keyword()) :: Stream.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.

Accepts the following Keyword options in opts:

sitemap_url - 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 (required)
gzip - Sets whether the files are gzipped (default: true)
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. (default: nil)

persist(enum, opts)

persist(Enumerable.t(), keyword()) :: Stream.t()

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

Will raise if persistence fails.

Accepts the following Keyword options in opts:

store - The module of the desired Sitemapper.Store, such as Sitemapper.S3Store. (required)
store_config - A Keyword list with options for the Sitemapper.Store. (optional, but usually required)

ping(enum, opts)

ping(Enumerable.t(), keyword()) :: Stream.t()

Receives a Stream of {filename, body} tuples, takes the last one (the index file), and pings Google and Bing with its URL.