serum v1.0.0 Serum.Plugins.SitemapGenerator

A Serum plugin that create a sitemap so that the search engine can index posts.

Using the Plugin

# serum.exs:
%{
  server_root: "https://example.io",
  plugins: [
    {Serum.Plugins.SitemapGenerator, only: :prod}
  ]
}

Link to this section Summary

Functions

Called if the whole build process has finished successfully.

Returns the short description of the plugin.

Returns the version requirement of Elixir.

Returns a list of optional callbacks which the plugin implements.

Returns the name of the plugin.

Returns the version requirement of Serum.

Returns the version of the plugin.

Link to this section Functions

Link to this function

build_succeeded(src, dest)

Called if the whole build process has finished successfully.

Callback implementation for Serum.Plugin.build_succeeded/2.

Returns the short description of the plugin.

You must implement this callback, or the plugin may fail.

Callback implementation for Serum.Plugin.description/0.

Returns the version requirement of Elixir.

Refer to this document for the string format.

You must implement this callback, or the plugin may fail.

Callback implementation for Serum.Plugin.elixir/0.

Returns a list of optional callbacks which the plugin implements.

For example, if your plugin implements build_started/2 and finalizing/2, you must implement this callback so that it returns [:build_started, :finalizing].

You must implement this callback, or the plugin may fail.

Callback implementation for Serum.Plugin.implements/0.

Returns the name of the plugin.

You must implement this callback, or the plugin may fail.

Callback implementation for Serum.Plugin.name/0.

Returns the version requirement of Serum.

Refer to this document for the string format.

You must implement this callback, or the plugin may fail.

Callback implementation for Serum.Plugin.serum/0.

Returns the version of the plugin.

The returned version string must follow the semantic versioning scheme.

You must implement this callback, or the plugin may fail.

Callback implementation for Serum.Plugin.version/0.