Documentation
Framulus documentation
What the editor does, what the document model holds, and how to connect your own AI to it.
Start
The editor
- CanvasPanning, zooming, selecting, snapping, and why the slide is finite.
- InspectorThe typed fields for position, size, type, colour and every per-element property.
- Code and markupThe slide as editable markup, and how it reconciles with what is on the canvas.
- StylesThe slide's stylesheet, what the reader accepts, and the :slide rule.
- ConsoleA typed command line for the open document, and the log of what an agent did to it.
The document
- Slides and formatsSlide sizes, why the format is the first decision, and how resizing works.
- Components and instancesMaking a reusable component from a selection, placing instances and overriding them.
- MastersThe elements that repeat on every slide, and how to edit them.
- Design systems and tokensThe document's own typed tokens, how they reach CSS, and what a font role is.
- VariablesBuilt-in and custom variables, written into text and resolved at render time.
Content
- Assets and image uploadsUploading images into a project, where the bytes live, and what deleting does.
- Phone and social mockupsDevice frames and social card elements, drawn by Framulus out of typed props with nothing fetched.
- Free photosSearching Pexels from inside the editor, and how a chosen photograph becomes a file the project owns.
- Crop and masksFit, focal point, crop zoom and the three mask shapes, none of which change the file.
- Motion ImagesA slide with declarative motion on it, a key photo, and exports for video, Apple Live Photo and Android Motion Photo.
- Charts and graphsData charts and mathematical function graphs, both drawn by Framulus itself.
- EquationsLaTeX typeset by KaTeX, inheriting the document's ink and size.
- Music notationA typed score with named notes, annotations that point at them, and note entry from the keyboard.
- Backgrounds and effectsFill layers on a slide, the effect stack on a slide or an element, and 3D tilt.
Output
- ExportPNG, JPG and PDF, what a scale does, and the two ceilings on it.
- Export destinationsRendering for TikTok and Instagram, and exactly what Framulus does and does not do.
- TemplatesSaving a project as a starting point, and who else can use it.
- Sharing and workspacesThe three ways somebody reaches a project, and what each role may do.
AI and agents
- AI and agentsHow an AI assistant works on a Framulus document, and what Framulus supplies.
- MCPThe endpoint, the tools and resources it publishes, and how authorization works.
- Connecting an AI clientSetting up Claude, Claude Code, Codex CLI and ChatGPT against your Framulus.
- Agent capabilities and limitsWhat a connected agent can read, what it can change, and what it can never do.