# Tiptapex v0.1.0 - Table of Contents

> Tiptap v3 rich-text editor for Phoenix LiveView: HEEx components, safe server-side JSON-to-HTML rendering, uploads, and optional realtime collaboration over Phoenix Channels.

## Pages

- [Tiptapex](readme.md)
- [Changelog](changelog.md)
- [LICENSE](license.md)

## Modules

- [Tiptapex](Tiptapex.md): Tiptap v3 rich-text editing for Phoenix LiveView.

- Components
  - [Tiptapex.Components](Tiptapex.Components.md): HEEx function components for the Tiptap editor and viewer.

- Rendering
  - [Tiptapex.Renderer](Tiptapex.Renderer.md): Renders Tiptap/ProseMirror JSON documents to safe HTML on the server.
  - [Tiptapex.Renderer.HTML](Tiptapex.Renderer.HTML.md): Safe HTML building blocks for `Tiptapex.Renderer`.
  - [Tiptapex.Renderer.Marks](Tiptapex.Renderer.Marks.md): Built-in mark renderers for `Tiptapex.Renderer`.
  - [Tiptapex.Renderer.Node](Tiptapex.Renderer.Node.md): Behaviour for custom node (or mark) renderers passed to
`Tiptapex.Renderer.to_html/2` via the `:nodes` / `:marks` options.
  - [Tiptapex.Renderer.Nodes](Tiptapex.Renderer.Nodes.md): Built-in node renderers for `Tiptapex.Renderer`.
  - [Tiptapex.Renderer.URL](Tiptapex.Renderer.URL.md): URL and CSS value sanitization for `Tiptapex.Renderer`.

- Uploads
  - [Tiptapex.Upload](Tiptapex.Upload.md): Behaviour for storing editor uploads.
  - [Tiptapex.Upload.Controller](Tiptapex.Upload.Controller.md): Drop-in controller action for editor uploads.
  - [Tiptapex.Upload.LocalDisk](Tiptapex.Upload.LocalDisk.md): A ready-made `Tiptapex.Upload` handler that writes files to local disk.
Intended for development, demos, and single-node deployments — for
production prefer a handler backed by object storage.
  - [Tiptapex.Upload.Validator](Tiptapex.Upload.Validator.md): Server-side validation for editor uploads: size limit, content-type
verification via magic-byte sniffing, and filename sanitization.

- Collaboration
  - [Tiptapex.Collab](Tiptapex.Collab.md): Realtime collaboration helpers.
  - [Tiptapex.Collab.Channel](Tiptapex.Collab.Channel.md): A Phoenix Channel implementing the Tiptapex collaboration wire protocol.

- Ecto
  - [Tiptapex.Schema.Document](Tiptapex.Schema.Document.md): An `Ecto.Type` for Tiptap/ProseMirror JSON documents.

