View Source API Reference Beacon v0.2.1

Beacon is a Content Management System for Phoenix LiveView.

Configuration for sites.

Raised when some option in Beacon.Config is invalid.

The building blocks for composing web pages: Layouts, Pages, Components, Stylesheets, and Snippets.

Beacon's representation of Phoenix Components, which can be used and re-used in your pages and layouts.

Beacon's representation of Phoenix's Component attributes.

Beacon's representation of Phoenix's Slots.

Beacon's representation of Phoenix's Slot attributes.

Stores a template which can be rendered for error responses.

Beacon's representation of a LiveView handle_event/3.

Beacon's representation of a LiveView handle_info/2 that applies to all of a site's pages.

The wrapper content for a Beacon.Content.Page.

Represents a point in time when a Beacon.Content.Layout was created or published.

Represents the template of a Beacon.Content.Layout at a specific moment in time.

Scopes Beacon.Content.LiveDataAssigns to Beacon.Content.Pages via site and path.

Dynamic key/value assigns to be used by Beacon.Content.Page templates and updated with Beacon.Content.EventHandlers.

Pages are the central piece of content in Beacon used to render templates with meta tags, components, and other resources.

Represents a point in time when a Beacon.Content.Page was created, published, or unpublished.

Custom page fields for pages.

Represents the template of a Beacon.Content.Page at a specific moment in time.

Stores an alternate template which can be randomly rendered as a replacement for a Page's standard template.

Snippet Helpers are blocks of custom Elixir code which can be called from meta tags and various other page fields.

Stores CSS content to use when rendering pages with Beacon.

Beacon is open for extensibility by allowing users to inject custom steps into its internal lifecycle.

Raised when Beacon attempts to load content into memory unsuccessfully.

Provides functions to upload and serve assets.

Assets are the images, videos, and any other media type uploaded and served by the Media Library.

Custom asset fields for assets.

Connects to an external service to store and serve assets in the Media Library.

Store assets in the database.

Store assets in S3 using the ex_aws library.

Metadata passed to page rendering lifecycle.

Functions which can be called in an Ecto migration for Beacon installation and upgrades.

Raised when Beacon's Markdown engine attempts to convert Markdown to HTML unsuccessfully.

Controls pages routing and provides helpers to mount sites in your application router and generate links to pages.

Compiles the CSS for a site using the compiler defined in Beacon.Config.css_compiler/0

Tailwind compiler for runtime CSS, used on all sites.

Raised when Beacon attempts to read content from memory unsuccessfully.

Raised when Beacon attempts to render a Beacon.Content.Snippets.Helper unsuccessfully.

Template for layouts, pages, and any other resource that display HTML/HEEx.

Handles loading and compilation of HEEx templates.

Metadata passed to page loading lifecycle.

GitHub Flavored Markdown

Metadata passed to page rendering lifecycle.

Testing utilities to create and assert Beacon resources.

Fixture data for testing Beacon content.

Convert between json and map enforcing the data shape as array of objects/maps.

Sites are identified as atoms and stored as string in the database.

Read-only container of Beacon assigns related to the current page.

Core layouts.

Raised when Beacon attempts to serve a page or asset on an invalid path.

Raised when a Beacon.Content.EventHandler or a Beacon.Content.InfoHandler returns an invalid response.

Generates a new Beacon site in the current project.

Generates a new Tailwind config in the format expected by Beacon

Installs Beacon in a Phoenix LiveView app.