# Astral v0.1.6 - Table of Contents

> Volt-powered static site generator for Elixir applications.

## Pages

- [Astral ✨](readme.md)
- [Changelog](changelog.md)
- [Astral Roadmap](roadmap.md)

- Introduction
  - [Getting Started](getting-started.md)
  - [Why Astral](why-astral.md)

- Features
  - [Pages and Layouts](pages-and-layouts.md)
  - [.astral Templates](astral-templates.md)
  - [Content Collections](content-collections.md)
  - [Markdown, Content, and Data Fetching](content-and-data.md)
  - [Routing, Pagination, and Generated Routes](pagination-and-routes.md)
  - [Navigation, i18n, Prefetch, and View Transitions](navigation.md)
  - [Server Runtime and Hybrid Rendering](server-runtime.md)
  - [Backend Services, Authentication, and Testing](backend-auth-testing.md)
  - [Feeds and Sitemaps](feeds-and-sitemaps.md)
  - [Assets](assets.md)
  - [Styling, Fonts, Scripts, and Frameworks](ui-and-browser-code.md)
  - [Development Server](development-server.md)
  - [Editor Setup and TypeScript](editor-and-typescript.md)
  - [Environment Variables](environment-variables.md)
  - [Plugins and Integrations](plugins.md)

- Deployment
  - [Static Builds](static-builds.md)

- Cheatsheets
  - [Configuration Cheatsheet](configuration.md)
  - [CLI Cheatsheet](cli.md)

## Modules

- [Astral](Astral.md): Volt-powered static site generation for Elixir applications.
- [Astral.Assets](Astral.Assets.md): Resolves browser paths for Volt-managed Astral assets.

- [Astral.BuildResult](Astral.BuildResult.md): Result returned by an Astral build.

- [Astral.Builder](Astral.Builder.md): Builds static Astral sites.
- [Astral.Collection](Astral.Collection.md): A configured content collection plus helpers for working with discovered entries.

- [Astral.Components](Astral.Components.md): Built-in Astral HEEx components available to pages, layouts, and Markdown.

- [Astral.Config](Astral.Config.md): Normalized build configuration for an Astral site.
- [Astral.Config.Reader](Astral.Config.Reader.md): Reads Astral configuration files.
- [Astral.Content](Astral.Content.md): Rendered source content and metadata for an Astral page.

- [Astral.Dev](Astral.Dev.md): Starts the supervised Astral development server.

- [Astral.DevConfig](Astral.DevConfig.md): Normalized configuration for Astral development servers.

- [Astral.DevServer](Astral.DevServer.md): Plug that serves an Astral site in development.
- [Astral.Discovery](Astral.Discovery.md): Discovers pages and layouts in an Astral project.

- [Astral.Entry](Astral.Entry.md): A content entry discovered from an Astral collection.

- [Astral.ErrorPage](Astral.ErrorPage.md): Renders development error pages for Astral routes.

- [Astral.HMRClient](Astral.HMRClient.md): Injects Volt's development HMR client into rendered HTML.

- [Astral.Heading](Astral.Heading.md): A Markdown heading discovered while rendering content.
- [Astral.Iconify](Astral.Iconify.md): Integrates PhoenixIconify with Astral builds and development rendering.
- [Astral.Image](Astral.Image.md): Build-time optimized images for Astral pages, layouts, and Markdown content.
- [Astral.Image.Builder](Astral.Image.Builder.md): Generates registered Astral image transforms into the static output tree.

- [Astral.Image.Config](Astral.Image.Config.md): Configuration for Astral's build-time image pipeline.
- [Astral.Image.Dev](Astral.Image.Dev.md): Development-time serving for optimized Astral images.
- [Astral.Image.Format](Astral.Image.Format.md): Canonical image format normalization for Astral's image pipeline.

- [Astral.Image.Metadata](Astral.Image.Metadata.md): Source image metadata used by Astral image transforms.

- [Astral.Image.Registry](Astral.Image.Registry.md): Per-render-process registry of image transforms requested by Astral content.
- [Astral.Image.Remote](Astral.Image.Remote.md): Remote image allowlisting and source caching.
- [Astral.Image.Remote.Pattern](Astral.Image.Remote.Pattern.md): A remote image allowlist pattern.
- [Astral.Image.Service](Astral.Image.Service.md): Behaviour for Astral image transformation backends.

- [Astral.Image.Source](Astral.Image.Source.md): A local image source resolved from content metadata.
- [Astral.Image.Transform](Astral.Image.Transform.md): A normalized image transform requested by rendered Astral content.

- [Astral.Image.Vips](Astral.Image.Vips.md): libvips-backed Astral image service implemented with the Elixir `Image` package.

- [Astral.Islands.Adapter](Astral.Islands.Adapter.md): Supported client-side island framework adapters.

- [Astral.Islands.Config](Astral.Islands.Config.md): Configuration for client-side Astral islands.

- [Astral.Islands.Entry](Astral.Islands.Entry.md): Bindings for generated island browser entry modules.

- [Astral.Islands.Island](Astral.Islands.Island.md): A client-side island requested while rendering Astral content.

- [Astral.Islands.Props](Astral.Islands.Props.md): Normalizes and encodes island props with validation errors tailored for Astral islands.
- [Astral.Islands.Registry](Astral.Islands.Registry.md): Per-render-process registry of client-side islands.
- [Astral.Islands.RuntimePlugin](Astral.Islands.RuntimePlugin.md): Volt plugin exposing shared browser runtime modules for Astral islands.

- [Astral.Islands.Writer](Astral.Islands.Writer.md): Writes generated browser entry modules for Astral islands.

- [Astral.Layout](Astral.Layout.md): Renders page layouts with EEx assigns.

- [Astral.Markdown](Astral.Markdown.md): Markdown rendering backed by MDEx.
- [Astral.Markdown.Images](Astral.Markdown.Images.md): Rewrites local Markdown image AST nodes into Astral image components.
- [Astral.Page](Astral.Page.md): A source page discovered by Astral.

- [Astral.Pagination](Astral.Pagination.md): Static pagination helpers for generated Astral routes.
- [Astral.Pagination.Page](Astral.Pagination.Page.md): A single static pagination page.
- [Astral.Pagination.URLs](Astral.Pagination.URLs.md): Navigation URLs for a static pagination page.

- [Astral.Plugin](Astral.Plugin.md): Behaviour for Astral site plugins.
- [Astral.Plugin.CollectionPages](Astral.Plugin.CollectionPages.md): Generated collection pagination plugin.
- [Astral.Plugin.Feed](Astral.Plugin.Feed.md): Generated Atom feed plugin.
- [Astral.Plugin.GeneratedRoutes](Astral.Plugin.GeneratedRoutes.md): Internal plugin for config-declared generated routes.
- [Astral.Plugin.Sitemap](Astral.Plugin.Sitemap.md): Generated `sitemap.xml` plugin.
- [Astral.PluginRunner](Astral.PluginRunner.md): Execute Astral plugin hooks.

- [Astral.Renderer](Astral.Renderer.md): Renders Astral pages to HTML.

- [Astral.Route](Astral.Route.md): A generated output route.
- [Astral.Route.File](Astral.Route.File.md): Converts portable file-route names into Astral route patterns.
- [Astral.Route.Path](Astral.Route.Path.md): A concrete static path produced from a dynamic page route.
- [Astral.Route.Pattern](Astral.Route.Pattern.md): Elixir-style route patterns for generated and dynamic Astral routes.
- [Astral.SVG](Astral.SVG.md): Inline server-rendered SVG assets for Astral templates.
- [Astral.Schema](Astral.Schema.md): Unified schema adapter for Astral content metadata.
- [Astral.Schema.Field](Astral.Schema.Field.md): A field declared in Astral's Ecto-style collection schema DSL.
- [Astral.Schema.Fields](Astral.Schema.Fields.md): Ecto-style field schema for collection metadata.
- [Astral.Site](Astral.Site.md): A discovered Astral site ready to render.

- [Astral.Template](Astral.Template.md): Renders `.astral` templates with HEEx semantics.
- [Astral.Template.AssetPlugin](Astral.Template.AssetPlugin.md): Volt plugin for browser assets embedded in `.astral` templates.
- [Astral.Template.Assets](Astral.Template.Assets.md): Extracts Volt-managed browser assets from `.astral` templates.
- [Astral.Template.HEEx](Astral.Template.HEEx.md): Compile-time bridge from Astral template source to Phoenix HEEx.
- [Astral.Template.Source](Astral.Template.Source.md): Source for an Astral template file.

## Mix Tasks

- [mix astral.build](Mix.Tasks.Astral.Build.md): Build an Astral site into static files.
- [mix astral.dev](Mix.Tasks.Astral.Dev.md): Start the Astral development server.
- [mix astral.install](Mix.Tasks.Astral.Install.md): Install an Astral starter site
- [mix astral.new](Mix.Tasks.Astral.New.md): Create an Astral starter site in the current project

