# Kotoba v0.5.0 - Table of Contents

> Rich text for Phoenix: a prebuilt Lexical editor, an Ecto content type, rendering and sanitization.

## Pages

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

- Guides
  - [Quickstart](quickstart.md)
  - [Forms and changesets](forms.md)
  - [Collaboration](collaboration.md)
  - [Editing features](features.md)
  - [Rendering](rendering.md)
  - [Uploads](uploads.md)
  - [Prompts and mentions](prompts.md)
  - [Suggestions](suggestions.md)
  - [Custom nodes](custom_nodes.md)
  - [Extensions](extensions.md)
  - [Theming](theming.md)

- Reference
  - [Security](security.md)
  - [Accessibility](accessibility.md)
  - [Known limits](limits.md)

## Modules

- [Kotoba.Collab](Kotoba.Collab.md): Collaboration for Kotoba with Phoenix as the document authority.
- [Kotoba.Collab.Channel](Kotoba.Collab.Channel.md): A Phoenix Channel with authenticated, read-only-aware collaboration.
- [Kotoba.Collab.DocServer](Kotoba.Collab.DocServer.md): The Phoenix authority for a shared document.
- [Kotoba.Collab.Document](Kotoba.Collab.Document.md): The versioned collaboration document and its semantic operations.
- [Kotoba.Collab.Store](Kotoba.Collab.Store.md): Atomic persistence for collaboration state and its rendered content.
- [Kotoba.Collab.Store.Memory](Kotoba.Collab.Store.Memory.md): An in-memory collaboration store for development and tests.
- [Kotoba.Collab.Supervisor](Kotoba.Collab.Supervisor.md): The application's supervisor for collaborative documents.

- Editor
  - [Kotoba](Kotoba.md): Kotoba (言葉) adds rich text to a Phoenix app.
  - [Kotoba.CodeLanguages](Kotoba.CodeLanguages.md): The code languages of the editor: the ones that it highlights and that its
language picker offers.
  - [Kotoba.Components](Kotoba.Components.md): Function components for the Kotoba editor and for rendered content.
  - [Kotoba.Features](Kotoba.Features.md): The built-in features of the editor, and the check of a document against
the features of a field.
  - [Kotoba.Live](Kotoba.Live.md): Helpers for a LiveView (or a LiveComponent) with a Kotoba editor.
  - [Kotoba.MarkdownPaste](Kotoba.MarkdownPaste.md): The server's half of pasted Markdown: a LiveComponent that
`Kotoba.Components.kotoba/1` renders next to each editor, so an app needs
no event handler for it.
  - [Kotoba.Prompts](Kotoba.Prompts.md): Prompts: a trigger character in the editor opens a menu of results, for
example `@` for people. A result inserts a mention, text (an emoji, a
snippet) or a node of the app. See the [Prompts](prompts.md) guide.

- Content
  - [Kotoba.Content](Kotoba.Content.md): An `Ecto.Type` that stores a rich text document with a cached rendering.
  - [Kotoba.Document](Kotoba.Document.md): A rich text document in memory.
  - [Kotoba.Renderer](Kotoba.Renderer.md): Renders a `Kotoba.Document` as HTML, as plain text and as Markdown.
  - [Kotoba.Sanitizer](Kotoba.Sanitizer.md): The structural checks that `Kotoba.Renderer` does before it renders a
node.

- Nodes
  - [Kotoba.Node](Kotoba.Node.md): The behaviour of a node in a `Kotoba.Document`.
  - [Kotoba.Node.Field](Kotoba.Node.Field.md): The description of one attribute of a `Kotoba.Node`.
  - [Kotoba.Nodes](Kotoba.Nodes.md): The node registry.
  - [Kotoba.Nodes.Attachment](Kotoba.Nodes.Attachment.md): A file in the document (type `"attachment"`), for example an image.
  - [Kotoba.Nodes.AutoLink](Kotoba.Nodes.AutoLink.md): A link that the editor made from a URL in the text (Lexical type
`"autolink"`). Its children are inline nodes.
  - [Kotoba.Nodes.Code](Kotoba.Nodes.Code.md): A code block (Lexical type `"code"`).
  - [Kotoba.Nodes.CodeHighlight](Kotoba.Nodes.CodeHighlight.md): A token of text in a code block (Lexical type `"code-highlight"`).
  - [Kotoba.Nodes.FootnoteDefinition](Kotoba.Nodes.FootnoteDefinition.md): The text of a footnote (type `"footnotedefinition"`): Markdown's
`[^label]: text`. The JSON key is `label`. It holds blocks, and is valid
only under the root.
  - [Kotoba.Nodes.FootnoteReference](Kotoba.Nodes.FootnoteReference.md): A reference to a footnote, in the text (type `"footnotereference"`):
Markdown's `[^label]`. The JSON key is `label`, the label of the
`Kotoba.Nodes.FootnoteDefinition` that it refers to.
  - [Kotoba.Nodes.Gallery](Kotoba.Nodes.Gallery.md): A gallery of images (Lexical type `"gallery"`): attachments shown
together, in a grid.
  - [Kotoba.Nodes.Heading](Kotoba.Nodes.Heading.md): A heading (Lexical type `"heading"`). `tag` is `"h1"` to `"h6"`.

  - [Kotoba.Nodes.HorizontalRule](Kotoba.Nodes.HorizontalRule.md): A horizontal rule (Lexical type `"horizontalrule"`).

  - [Kotoba.Nodes.Image](Kotoba.Nodes.Image.md): An image from a URL, in the text (type `"image"`): Markdown's
`![alt](url "title")`. The JSON keys are `url`, `alt` and `title`.
  - [Kotoba.Nodes.LineBreak](Kotoba.Nodes.LineBreak.md): A line break in a block (Lexical type `"linebreak"`).

  - [Kotoba.Nodes.Link](Kotoba.Nodes.Link.md): A link (Lexical type `"link"`). Its children are inline nodes.
  - [Kotoba.Nodes.List](Kotoba.Nodes.List.md): A list (Lexical type `"list"`).
  - [Kotoba.Nodes.ListItem](Kotoba.Nodes.ListItem.md): An item of a list (Lexical type `"listitem"`).
  - [Kotoba.Nodes.Mention](Kotoba.Nodes.Mention.md): A mention of a thing in the app (type `"mention"`), for example a person.
The JSON keys are `kind`, `id` and `label`.
  - [Kotoba.Nodes.Paragraph](Kotoba.Nodes.Paragraph.md): A paragraph (Lexical type `"paragraph"`).
  - [Kotoba.Nodes.Quote](Kotoba.Nodes.Quote.md): A block quote (Lexical type `"quote"`).
  - [Kotoba.Nodes.Root](Kotoba.Nodes.Root.md): The root node of a document (Lexical type `"root"`).
  - [Kotoba.Nodes.Tab](Kotoba.Nodes.Tab.md): A tab character (Lexical type `"tab"`).
  - [Kotoba.Nodes.Table](Kotoba.Nodes.Table.md): A table (Lexical type `"table"`).
  - [Kotoba.Nodes.TableCell](Kotoba.Nodes.TableCell.md): A cell of a table (Lexical type `"tablecell"`).
  - [Kotoba.Nodes.TableRow](Kotoba.Nodes.TableRow.md): A row of a table (Lexical type `"tablerow"`).
  - [Kotoba.Nodes.Text](Kotoba.Nodes.Text.md): A run of text (Lexical type `"text"`).
  - [Kotoba.Nodes.Unknown](Kotoba.Nodes.Unknown.md): A node of a type that is not in the node registry.

- Attachments
  - [Kotoba.Attachments](Kotoba.Attachments.md): Server-side checks of an uploaded file, before it becomes an attachment
node.
  - [Kotoba.Storage](Kotoba.Storage.md): The behaviour of a file store for attachments.
  - [Kotoba.Storage.Local](Kotoba.Storage.Local.md): A `Kotoba.Storage` adapter that keeps files in a directory on the local
disk.
  - [Kotoba.Storage.Local.Plug](Kotoba.Storage.Local.Plug.md): Serves the files of `Kotoba.Storage.Local`, read only.

## Mix Tasks

- [mix kotoba.build](Mix.Tasks.Kotoba.Build.md): Builds the Kotoba editor into `priv/static`.
- [mix kotoba.gen.node](Mix.Tasks.Kotoba.Gen.Node.md): Generates the two halves of an app-defined node, and a test.
- [mix kotoba.install](Mix.Tasks.Kotoba.Install.md): Sets up Kotoba in a Phoenix application.
- [mix kotoba.release_check](Mix.Tasks.Kotoba.ReleaseCheck.md): Checks the built files before a release of Kotoba.