# og_ex v0.3.0 - Table of Contents

> Embedded Open Graph and Twitter card rendering for Phoenix

## Pages

- Guides
  - [OgEx](readme.md)
  - [Public API reference](function-reference.md)

- Maintainers
  - [Internal architecture](internal-architecture.md)
  - [Native releases and publishing](native-releases.md)

## Modules

- Controller API
  - [OgEx](OgEx.md): Open Graph and Twitter/X image support for Phoenix controllers.
  - [OgEx.Card](OgEx.Card.md): Behaviour and setup macro for generated social cards.
  - [OgEx.Controller](OgEx.Controller.md): Adds action-level social-card declarations to a Phoenix controller.
  - [OgEx.Router](OgEx.Router.md): Installs the final path-image handler in a Phoenix router.

- Image API
  - [OgEx.Image](OgEx.Image.md): Normalizes and loads image sources.
  - [OgEx.Image.Resource](OgEx.Image.Resource.md): Verified image bytes returned by an `OgEx.ResourceLoader`.
  - [OgEx.Image.Source](OgEx.Image.Source.md): Normalized description of an image source.

- Extension points
  - [OgEx.Cache](OgEx.Cache.md): Behaviour for final generated-image caches.
  - [OgEx.Cache.ETS](OgEx.Cache.ETS.md): Default in-memory generated-image cache.
  - [OgEx.Renderer](OgEx.Renderer.md): Behaviour for HTML-to-image rendering backends.
  - [OgEx.Renderer.Takumi](OgEx.Renderer.Takumi.md): Native Takumi implementation of `OgEx.Renderer`.
  - [OgEx.ResourceLoader](OgEx.ResourceLoader.md): Behaviour for loading normalized image sources.
  - [OgEx.ResourceLoader.Default](OgEx.ResourceLoader.Default.md): Built-in resource loader.
  - [OgEx.ResourceLoader.Remote](OgEx.ResourceLoader.Remote.md): Opt-in HTTP loader for images embedded in generated cards.

- Runtime internals
  - [OgEx.Config](OgEx.Config.md): Normalized configuration for one page's social metadata and image response.
  - [OgEx.ResourceCache](OgEx.ResourceCache.md): Bounded in-memory cache for verified remote resources.
  - [OgEx.Resources](OgEx.Resources.md): Discovers and loads image resources referenced by generated-card HTML.

