MDZip Documentation

Guides and references for the MDZip format and tools.

Open, create, and validate your first .mdz — with Studio, VS Code, the browser tools, or the CLI.

Create, inspect, validate, and edit .mdz archives from the command line: install, command tour, and scripting notes.

Editor

Embed the @mdzip/editor workspace in web or desktop apps: packages, API, control policies, events, and the framework wrappers.

Theming the @mdzip/editor component: color schemes, CSS variables, and integrating with a host application look.

The @mdzip/editor package for vanilla JavaScript/TypeScript: install, mount the workspace view, and configure it.

The @mdzip/editor-ng wrapper: use the MDZip workspace editor as an Angular component.

The @mdzip/editor-react wrapper: use the MDZip workspace editor as a React component.

The @mdzip/editor-vue wrapper: use the MDZip workspace editor as a Vue component.

How AI assistants and automated tools create valid .mdz archives: minimal archive, manifest, entry-point rules, common mistakes, validation.

Canonical, validating .mdz examples: minimal, with images, and multi-document project mode — templates for producers and fixtures for implementers.

How .mdz relates to TextBundle/TextPack, EPUB, and DOCX — acknowledged prior work, a comparison table, and the interoperability stance.