# PhoenixMountable v0.2.1 - Table of Contents

> Build libraries that mount into a Phoenix app: routes, LiveViews, assets, auth, processes and migrations in one package.

## Pages

- [PhoenixMountable](readme.md)
- [Changelog](changelog.md)

- Guides
  - [Building a mountable library](building-a-mountable-library.md)
  - [Assets](assets.md)
  - [Migrations](migrations.md)
  - [Processes](processes.md)
  - [Installers](installers.md)
  - [Testing](testing.md)

## Modules

- Core
  - [PhoenixMountable](PhoenixMountable.md): Build libraries that mount into a Phoenix app.
  - [PhoenixMountable.Definition](PhoenixMountable.Definition.md): The macros of a definition module: `options/1`, `routes/1` and `pipeline/2`.
  - [PhoenixMountable.HTML](PhoenixMountable.HTML.md): Tags for a library's own root layout, usable from any template engine.
  - [PhoenixMountable.Layout](PhoenixMountable.Layout.md): Components for a library's root layout, and a ready-made root layout.
  - [PhoenixMountable.Mount](PhoenixMountable.Mount.md): One mounted instance of a mountable library.
  - [PhoenixMountable.Path](PhoenixMountable.Path.md): Paths relative to the mount: the `~m` sigil.
  - [PhoenixMountable.Routes](PhoenixMountable.Routes.md): The macros available inside `PhoenixMountable.Definition.routes/1`.

- Assets
  - [PhoenixMountable.Assets](PhoenixMountable.Assets.md): How a mountable library's CSS and JavaScript reach the browser.
  - [PhoenixMountable.Assets.Embedded](PhoenixMountable.Assets.Embedded.md): Assets read, concatenated and gzipped at compile time, and served from
memory under content-hashed URLs.
  - [PhoenixMountable.Assets.Host](PhoenixMountable.Assets.Host.md): The host's own asset pipeline.
  - [PhoenixMountable.Assets.Static](PhoenixMountable.Assets.Static.md): A directory of built files served under the mount.

- Processes
  - [PhoenixMountable.PubSub](PhoenixMountable.PubSub.md): PubSub topics scoped to a mount.
  - [PhoenixMountable.Singleton](PhoenixMountable.Singleton.md): Runs a process once per cluster.
  - [PhoenixMountable.Supervisor](PhoenixMountable.Supervisor.md): Starts the processes of every mount of a host router when the host boots.
  - [PhoenixMountable.Telemetry](PhoenixMountable.Telemetry.md): Telemetry events emitted by PhoenixMountable.

- Migrations
  - [PhoenixMountable.Backfill](PhoenixMountable.Backfill.md): Data migrations, kept apart from schema changes and run in batches.
  - [PhoenixMountable.Backfill.Runner](PhoenixMountable.Backfill.Runner.md): Runs a library's deferred backfills in the running app.
  - [PhoenixMountable.Migration](PhoenixMountable.Migration.md): One version of a mountable library's schema.
  - [PhoenixMountable.Migration.Helpers](PhoenixMountable.Migration.Helpers.md): Functions imported in `PhoenixMountable.Migration` modules.

  - [PhoenixMountable.MigrationError](PhoenixMountable.MigrationError.md): Raised when a library's migration cannot run in the database's current
state: a backfill it needs has not finished, it must run outside a
transaction, or a version cannot be rolled back.

  - [PhoenixMountable.Migrations](PhoenixMountable.Migrations.md): Versioned migrations for a mountable library's tables in the host's database.
  - [PhoenixMountable.Migrations.Context](PhoenixMountable.Migrations.Context.md): What a library's migration version receives.
  - [PhoenixMountable.Migrations.Generator](PhoenixMountable.Migrations.Generator.md): Writes the host's migration for installing or upgrading a library.
  - [PhoenixMountable.Migrations.OutdatedError](PhoenixMountable.Migrations.OutdatedError.md): Raised when a host's database is behind the schema a mountable library needs.
  - [PhoenixMountable.Migrations.SQLite](PhoenixMountable.Migrations.SQLite.md): Table rebuilds for SQLite, whose `ALTER TABLE` cannot change a column.
  - [PhoenixMountable.Migrations.Test](PhoenixMountable.Migrations.Test.md): Checks for a library's migrations, run against a real database in the
library's own test suite.

- Installers
  - [PhoenixMountable.Igniter](PhoenixMountable.Igniter.md): Building blocks for a mountable library's Igniter installer.
  - [PhoenixMountable.Igniter.HostAssets](PhoenixMountable.Igniter.HostAssets.md): Edits of the host's `assets/js/app.js` and `assets/css/app.css`, for a
library whose components render in the host's own pages (a button in
its header, a palette, a picker) and need a LiveView hook and a style
sheet there. `PhoenixMountable.Igniter.add_hook/4` and
`PhoenixMountable.Igniter.add_css_imports/3` apply them.
  - [PhoenixMountable.Install](PhoenixMountable.Install.md): A mountable library's installer, declared in one `use`

- Testing
  - [PhoenixMountable.Test](PhoenixMountable.Test.md): Helpers for testing a mountable library.
  - [PhoenixMountable.TestHost](PhoenixMountable.TestHost.md): A host app for a mountable library's tests.

## Mix Tasks

- [mix phoenix_mountable.check](Mix.Tasks.PhoenixMountable.Check.md): Checks every library using `PhoenixMountable.Migrations` against the
database, for CI.
- [mix phoenix_mountable.gen.migration](Mix.Tasks.PhoenixMountable.Gen.Migration.md): Generates the host migration that installs or upgrades a library's tables.

- Migrations
  - [mix phoenix_mountable.backfill](Mix.Tasks.PhoenixMountable.Backfill.md): Runs a library's deferred backfills to completion.