Astral (Astral v0.1.0)

Copy Markdown View Source

Volt-powered static site generation for Elixir applications.

Astral is intentionally separate from Volt. Volt owns generic asset building, dev-server, and HMR primitives; Astral will own site concepts such as pages, routes, layouts, content, and static output.

Summary

Functions

Return the browser path for a Volt-managed source asset.

Build a static Astral site.

Start a supervised Astral development server.

Return the package version.

Functions

asset_path(site_or_config, source)

@spec asset_path(Astral.Site.t() | Astral.Config.t(), String.t()) :: String.t()

Return the browser path for a Volt-managed source asset.

build(opts \\ [])

@spec build(keyword() | Astral.Config.t()) ::
  {:ok, Astral.BuildResult.t()} | {:error, term()}

Build a static Astral site.

dev(opts \\ [])

@spec dev(keyword()) :: Supervisor.on_start()

Start a supervised Astral development server.

version()

@spec version() :: String.t()

Return the package version.