# Diazoma

> Diazoma turns any list on the web (a feed, a catalog, a gallery, an archive) into a curved, searchable wall: a magic window on desktop and phone, and a wall around you in a WebXR headset. The code and JSON Schemas are Apache-2.0, the spec text is CC-BY-4.0.

Diazoma has one rendering package (`@diazoma/wall`) and adapters (`@diazoma/adapters`) for each way a site can describe itself: DOM annotations (Level 1), a JSON feed with a manifest at `/.well-known/wall.json` (Level 2), the embedded wall (Level 3), and recipes for sites that publish nothing (Level 0).

## Docs

- [Getting started](https://diazoma.app/docs/): the levels and the shortest path
- [Embed with one script tag](https://diazoma.app/docs/embed/): diazoma-embed.js and its attributes
- [Site manifest](https://diazoma.app/docs/manifest/): /.well-known/wall.json
- [Feeds](https://diazoma.app/docs/feeds/): the JSON feed, cursors, search and filters
- [Item fields](https://diazoma.app/docs/items/): required and optional fields of an item
- [Image sizes](https://diazoma.app/docs/image-sizes/): how smaller copies of a picture are found
- [View customization](https://diazoma.app/docs/view/): buttons, panel, rows, colours, texts and their limits
- [Actions and login](https://diazoma.app/docs/actions/): session actions, CSRF, phone sign-in
- [Recipes](https://diazoma.app/docs/recipes/): declarative per-site recipes and the diazoma-recipe command
- [Adapters API](https://diazoma.app/docs/adapters/): @diazoma/adapters
- [Wall API](https://diazoma.app/docs/wall-api/): @diazoma/wall options and events
- [Validation and compat levels](https://diazoma.app/docs/validation/): the diazoma-spec validator
- [Security and privacy](https://diazoma.app/docs/security/): policy deny, untrusted input
- [Browser extension](https://diazoma.app/docs/extension/): Chrome and Edge, levels, permissions
- [Privacy policy](https://diazoma.app/privacy/): what the extension stores and sends
- [WordPress plugin](https://diazoma.app/docs/wordpress/) and [Laravel plugin](https://diazoma.app/docs/laravel/)

## Spec

- [Site compatibility specification, version 1](https://diazoma.app/spec/)
- [manifest.schema.json](https://diazoma.app/spec/v1/manifest.schema.json)
- [feed.schema.json](https://diazoma.app/spec/v1/feed.schema.json)
- [item.schema.json](https://diazoma.app/spec/v1/item.schema.json)
- [view.schema.json](https://diazoma.app/spec/v1/view.schema.json)
- [recipe.schema.json](https://diazoma.app/spec/v1/recipe.schema.json)

## Optional

- [Live demo](https://diazoma.app/demo/): the wall over Wikimedia Commons, NASA Image of the Day and ESO news
- [Docs FAQ](https://diazoma.app/docs/faq/)