serum v0.13.0 API Reference

Modules

Defines Serum OTP application.

A module for managing the overall project build procedure.

Renders each fragment into a full HTML page and writes to a file.

Processes/parses the input files to produce the intermediate data.

Renders page/post/post list structs into a page fragment.

A module responsible for rendering complete HTML pages.

The Serum development server.

A Cowboy Websocket handler that sends signals to clients on file events.

A looper which accepts user inputs as server commands and processes them.

A GenServer that provides some utility functions while the Serum development server is running.

Defines a struct representing a file to be read or written.

Defines a struct representing a page fragment.

Provides an interface to an Agent which stores site-wide template variable bindings.

This module takes care of parsing headers of page (or post) source files.

Defines a struct describing a normal page.

A behaviour that all Serum plugin module must implement.

A Serum plugin that injects the live reloader script at the end of HTML files.

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

A Serum plugin that inserts a table of contents.

Defines a struct representing a blog post page.

Defines a struct representing a list of blog posts.

This module defines a struct for storing Serum project metadata.

A module for validation of Serum project definition data.

This module provides functions related to validating project JSON files.

A module for loading Serum project definition files.

This module provides functions for rendering pages into HTML.

This module defines types for positive results or errors returned by functions in this project.

This module defines Tag struct.

Defines a struct which stores a template and its information.

This module handles template loading and preprocessing.

Provides helper macros for EEx templates.

This module provides some frequently used shortcut functions. These functions are inlined by the compiler.

Mix Tasks

Prints a list of available Serum tasks.

Builds the Serum project at the specified directory.

Adds a new page to the current project.

Adds a new blog post to the current project.

Starts the Serum development server.