API Reference Astral v#0.2.2

Copy Markdown View Source

Modules

Volt-powered static site generation for Elixir applications.

Resolves browser paths for Volt-managed Astral assets.

Result returned by an Astral build.

Builds static Astral sites.

A configured content collection plus helpers for working with discovered entries.

Built-in Astral HEEx components available to pages, layouts, and Markdown.

Normalized build configuration for an Astral site.

Reads Astral configuration files.

Process-local state used while evaluating Astral config DSL files.

Rendered source content and metadata for an Astral page.

Starts the supervised Astral development server.

Normalized configuration for Astral development servers.

Plug that serves an Astral site in development.

Discovers pages and layouts in an Astral project.

A content entry discovered from an Astral collection.

Renders development error pages for Astral routes.

Injects Volt's development HMR client into rendered HTML.

A Markdown heading discovered while rendering content.

Integrates PhoenixIconify with Astral builds and development rendering.

Build-time optimized images for Astral pages, layouts, and Markdown content.

Generates registered Astral image transforms into the static output tree.

Configuration for Astral's build-time image pipeline.

Development-time serving for optimized Astral images.

Canonical image format normalization for Astral's image pipeline.

Source image metadata used by Astral image transforms.

Per-render-process registry of image transforms requested by Astral content.

Remote image allowlisting and source caching.

A remote image allowlist pattern.

Behaviour for Astral image transformation backends.

A local image source resolved from content metadata.

A normalized image transform requested by rendered Astral content.

libvips-backed Astral image service implemented with the Elixir Image package.

Supported client-side island framework adapters.

Configuration for client-side Astral islands.

Bindings for generated island browser entry modules.

A client-side island requested while rendering Astral content.

Normalizes and encodes island props with validation errors tailored for Astral islands.

Per-render-process registry of client-side islands.

Volt plugin exposing shared browser runtime modules for Astral islands.

Writes generated browser entry modules for Astral islands.

Renders page layouts with EEx assigns.

Markdown rendering backed by MDEx.

Rewrites local Markdown image AST nodes into Astral image components.

A source page discovered by Astral.

Static pagination helpers for generated Astral routes.

A single static pagination page.

Navigation URLs for a static pagination page.

Behaviour for Astral site plugins.

Generated collection pagination plugin.

Generated Atom feed plugin.

Internal plugin for config-declared generated routes.

Generated sitemap.xml plugin.

Execute Astral plugin hooks.

Renders Astral pages to HTML.

A generated output route.

Converts portable file-route names into Astral route patterns.

A concrete static path produced from a dynamic page route.

Elixir-style route patterns for generated and dynamic Astral routes.

Inline server-rendered SVG assets for Astral templates.

Unified schema adapter for Astral content metadata.

A field declared in Astral's Ecto-style collection schema DSL.

Ecto-style field schema for collection metadata.

A discovered Astral site ready to render.

Renders .astral templates with HEEx semantics.

Volt plugin for browser assets embedded in .astral templates.

Extracts Volt-managed browser assets from .astral templates.

Compile-time bridge from Astral template source to Phoenix HEEx.

Source for an Astral template file.

Mix Tasks

Build an Astral site into static files.

Start the Astral development server.

Install an Astral starter site

Create an Astral starter site in the current project