A behaviour that all Serum theme module must implement.

A Serum theme is a set of predefined templates and assets which are used while Serum is building a project.

More specifically, a Serum theme is a Mix project which has the following contents:

• Modules that implement this behaviour,
• And theme files such as templates, includes, and other assets. These files are usually stored in the priv/ directory.

Your theme package must have at least one module that implements this behaviour, as Serum will call callbacks of this behaviour to ensure that your modules provide appropriate theme resources when needed.

Using Serum Themes

To use a Serum theme, you first need to add the theme package to your dependencies list.

# mix.exs
defp deps do
[
  {:serum, "~> 1.0"},
  # ...

  # If the theme is available on Hex.pm:
  {:serum_theme_sample, "~> 1.0"}

  # If the theme is available on somewhere else:
  {:serum_theme_sample, git: "https://github.com/..."}
]
end

Fetch and build the theme package using mix.

$ mix do deps.get, deps.compile

To configure your Serum project to use a theme, you need to put a :theme key in your serum.exs.

# serum.exs:
%{
  theme: Serum.Themes.Sample,
  # ...
}

Read the documentation provided by the theme author, to see the list of files the theme consists of. Files provided by the theme are always overridden by corresponding files in your project directory. So it is safe to remove files from your project if the theme has ones.

Finally, try building your project to see if the theme is applied correctly.

$ mix serum.server
# Or,
$ MIX_ENV=prod mix serum.build