API Reference Griffin v0.4.0

View Source

Modules

Griffin is a Static Site Generator.

Helper functions for handling basic file operations

Module for non-named GenServer responsible for watching for changes. Executes a generic callback when file changes are detected. Used for the LiveReload HTTPServer that is launched as part of mix grf.server.

Module responsible for compiling layouts. Stores compiled layouts in an ETS table. Supports nested layouts with a maximum nesting depth of 10.

Defines a simple HTTP server with LiveReload. Spawned from the grf.server task. PlugLiveReload doesn't work within the context of a Plug.Builder, so we can't use Plug.Static to serve the files. Instead, we use Plug.Router and need to implement the file serving logic, which is... unfortunate.

Mix Tasks

Generates a static website from template and layout files.

Generates a new Markdown page with relevant front matter attributes.

Starts up a local development server using plug_cowboy. The local server watches for file changes and re-runs grf.build on file change, but does not reload the file in the browser. This server is NOT meant to be run in production.