# Ink

> Build small, fast Light Phone III apps with TypeScript.

## Docs

- [Get started](https://ink.noscroll.ing/get-started): Install Ink, create an app and run it on a Light Phone III.
- [Project structure](https://ink.noscroll.ing/project-structure): App files, folders and generated output.

## Guides

- [Build an APK](https://ink.noscroll.ing/build-app): Build and sign an Android app for distribution.
- [Design exports](https://ink.noscroll.ing/design-export): Export Ink screens as images for chat and tldraw.
- [Request a permission](https://ink.noscroll.ing/permissions-guide): Check and request permissions.

## Ink Components

- [Screens and layout](https://ink.noscroll.ing/screens): Arrange content, headers and tabs.
- [Text](https://ink.noscroll.ing/text): Display and format text.
- [Buttons](https://ink.noscroll.ing/buttons): Run an action or open a page.
- [Inputs](https://ink.noscroll.ing/text-input): Text entry with the device’s keyboard.
- [Fields](https://ink.noscroll.ing/fields): Show a labelled value.
- [Toggles](https://ink.noscroll.ing/toggles): Turn a setting on or off.
- [Selection](https://ink.noscroll.ing/selection): Choose one option.
- [Images](https://ink.noscroll.ing/images): Display artwork and photos.
- [Icons](https://ink.noscroll.ing/icons): Use Material icons or custom SVGs.
- [Rows](https://ink.noscroll.ing/rows): Display a title, subtitle and optional image.
- [Lists](https://ink.noscroll.ing/lists): Display scrolling collections.
- [Reordering](https://ink.noscroll.ing/reordering): Move items up or down with arrow buttons.
- [Screen states](https://ink.noscroll.ing/screen-states): Show loading, empty and error states.
- [Confirmation](https://ink.noscroll.ing/confirmation): Confirm an action.
- [Playing screen](https://ink.noscroll.ing/playing-screen): Display artwork and playback controls.
- [Video](https://ink.noscroll.ing/video): Play videos.
- [Conversations](https://ink.noscroll.ing/conversations): Display messages, replies and a composer.
- [Photo and video picker](https://ink.noscroll.ing/media-picker): Select photos and videos.
- [Codes](https://ink.noscroll.ing/codes): Display QR codes and barcodes.
- [Maps](https://ink.noscroll.ing/maps): Display a full-screen map.
- [Canvas](https://ink.noscroll.ing/canvas): Draw rectangles, text and icons.

## Reference

- [Navigation](https://ink.noscroll.ing/navigation): Open pages, pass values and arrange tabs.
- [Resources and actions](https://ink.noscroll.ing/data): Load data, reuse it across screens and save changes.

## Modules

- [Audio](https://ink.noscroll.ing/audio): Play audio, record files and analyse microphone input.
- [Accounts and sign-in](https://ink.noscroll.ing/auth): Sign in with OAuth and manage account sessions.
- [Background work](https://ink.noscroll.ing/background): Schedule work to run after the app closes.
- [Barcodes and passes](https://ink.noscroll.ing/barcode): Display codes and scan them natively.
- [Camera](https://ink.noscroll.ing/camera): Preview and capture photos.
- [Clipboard](https://ink.noscroll.ing/clipboard): Copy and paste plain text.
- [Encryption](https://ink.noscroll.ing/crypto): Encrypt and decrypt text with a shared key.
- [Files and media](https://ink.noscroll.ing/files): Choose, save and upload files.
- [LightOS](https://ink.noscroll.ing/light-sdk): Read LightOS preferences and use system services.
- [Location](https://ink.noscroll.ing/location): Read a location or subscribe to updates.
- [NFC](https://ink.noscroll.ing/nfc): Read supported tags through native sessions.
- [Notifications](https://ink.noscroll.ing/notifications): Local reminders and routes back into the app.
- [Secure store](https://ink.noscroll.ing/secure-store): Store credentials with Android Keystore protection.
- [Store](https://ink.noscroll.ing/store): Save settings and small collections between app sessions.

### Network

- [Network](https://ink.noscroll.ing/network): Use fetch with native HTTP transport.
- [Connectivity](https://ink.noscroll.ing/connectivity): Read and watch the device’s network connection.
- [Downloads](https://ink.noscroll.ing/downloads): Download files and track progress after a screen closes.

## Contributing and internals

- [How Ink works](https://ink.noscroll.ing/architecture): How Ink builds and runs apps.

## Other

- [Releases](https://ink.noscroll.ing/releases): Build, verify and publish an Ink release.
- [Rust and JavaScript ownership](https://ink.noscroll.ing/runtime-ownership)

## Agent skills

- [ink](https://ink.noscroll.ing/.well-known/agent-skills/ink/SKILL.md): Read the Ink docs instead of answering from memory. Build small, fast Light Phone III apps with TypeScript. Use when a task involves Ink: how it works, how to set it up or configure it, or its API.

## Agent resources

- [llms-full.txt](https://ink.noscroll.ing/llms-full.txt): The full Markdown of every page in one file.
- [Page Markdown](https://ink.noscroll.ing/index.md): Append `.md` to any page URL to fetch that page as raw Markdown.
- [JSON API](https://ink.noscroll.ing/api/docs/pages.json): Page index of the JSON docs API; each entry links the page's JSON and Markdown forms. Described by the OpenAPI document at https://ink.noscroll.ing/openapi.json.
- [Agent skills](https://ink.noscroll.ing/.well-known/agent-skills/index.json): Agent Skills discovery index of the skills this site publishes.
- [API catalog](https://ink.noscroll.ing/.well-known/api-catalog): RFC 9727 linkset of the APIs documented here.
- [AI catalog](https://ink.noscroll.ing/.well-known/ai-catalog.json): ARD manifest of the agent-facing resources on this site (MCP server, skills, APIs).
- [agent-readability.json](https://ink.noscroll.ing/agent-readability.json): Manifest of every agent-facing artifact on this site.
- [Sitemap](https://ink.noscroll.ing/sitemap.xml): Every indexable page URL with its last-modified date.