Skip to content

opral/atelier

Repository files navigation

Atelier

The embeddable lix workspace

Atelier is a workspace UI — editor, files, history, and diffs — that mounts into any host application. Hosts bring their own lix; Atelier renders the space to work in it.

Atelier is the workspace engine inside any host. The included web preview demonstrates a browser app backed by Lix.

Why "Atelier"?

Atelier (French, [atəlje]) is an artist's workshop — the private studio where an artist and their assistants make the work. Not the gallery where it's shown, not the storage where it's kept: the room where the work actually happens.

That's this component's job. Lix holds the workspace — the files, the history, every change. Atelier is the room you step into to work on it.

Usage

import { openLix } from "@lix-js/sdk";
import { createAtelier } from "@opral/atelier";
import "@opral/atelier/style.css";

// The host creates and owns the lix.
const lix = await openLix();

createAtelier({
	element: document.getElementById("mount"),
	lix,
});

The target runtime is the browser. Anything that can hand Atelier a DOM element and a lix can host it — a web app or a preview deployment.

What's in the workspace

Feature Description
Editor Markdown-native writing surface.
Files Browse and open the files in the lix workspace.
Inline diffs Keep or undo edits with word-level context.
History Inspect checkpoints and restore earlier drafts.

Powered by Lix

Atelier's change control is powered by Lix, a version control system that can handle any file format and is designed for building applications on top of.

Status

Atelier exposes the minimal createAtelier({ element, lix }) entry point. The development preview lives under preview/web/.

License

Atelier is released under the MIT License.

About

The embeddable lix workspace

Resources

License

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages