Paged

Paged is the open-source system that reads, renders, and edits IDML. This is the platform half of the documentation: the render engine and its WebGPU SDK, the paged.* scripting layer, the plugin SDK, and the live capability state. The other half is the IDML Reference — the format these tools act on.

In short The two references cross-link throughout. Every IDML construct carries a live badge showing how far Paged takes it — parsed, rendered, mutable, scriptable — sourced from the same capability registry surfaced here. Every API on this side points back to the format concept it reads or writes. Both are generated from the system's own artifacts, so they stay true as the code moves.

▶Run live demodraw-fill — the real editor, driven by a script

Developer reference

• Viewer SDKIntermediateII· explanationthe WebGPU rendering API (@paged-media/idml-viewer): load a document, render its pages, drive a pan/zoom camera. Read-only.
• ScriptingIntermediateII· explanationthe paged.* host surface: read, mutate, and author documents from JavaScript, with a live playground.
• Plugin SDKIntermediateII· explanationthe contract for extending the editor with tools, panels, commands, and content types.

The system

• PluginsBeginnerI· explanationthe first-party content plugins: draw, web, image, sheets, data, Word, slides, IDML and PDF.
• RepositoriesBeginnerI· explanationhow the engine, editor, server, viewer, and cockpit (the capability registry) repos fit together.
• Capability stateBeginnerI· referencethe live matrix of what works, at which layer, backed by test evidence. The system's source of truth for status.

The platform documentation is generated from the system itself wherever possible — the capability registry, the engine's scripting catalog, the plugin manifest schema, the server's OpenAPI spec, and the repos' commit history. When the software changes, these pages change on the next build. See how the capability state works.