MDZip Documentation

Guides and references for the MDZip format and tools.

Getting Started with MDZip

Open, create, and validate your first .mdz file with MDZip Studio, VS Code, the browser tools, or the mdz CLI, then see what's inside and how it opens.

Using the mdz CLI

Create, inspect, validate, and edit .mdz archives from the command line with the mdz CLI: installing it, a tour of the commands, extraction, and scripting.

Editor

Editor Developer Guide

Embed the @mdzip/editor workspace in web or desktop apps: packages, modes and controls, the browser API, preview lifecycle, links, toolbars, and wrappers.

Editor Theming

Theme the @mdzip/editor component: light and dark color schemes, custom themes, the CSS variable reference, theme constants, multiple editors, accessibility.

JavaScript

Use @mdzip/editor in plain JavaScript or TypeScript: install it, mount the workspace view, and set the editor mode, control presets, density, and file handling.

Angular

Use the MDZip workspace editor as an Angular component with @mdzip/editor-ng: install it, bind inputs and outputs, show archive diffs, and handle files.

React

Use the MDZip workspace editor as a React component with @mdzip/editor-react: install it, set props and callbacks, show diffs, and use the imperative API.

Vue

Use the MDZip workspace editor as a Vue component with @mdzip/editor-vue: install it, bind props and events, show archive diffs, and handle images and files.

AI Producer Guide

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

Example Archives

Example .mdz archives that pass validation: a minimal file, one with images, and a multi-document project, as templates for producers and implementer fixtures.

MDZip and Related Formats

How .mdz compares to TextBundle/TextPack, EPUB, DOCX, and the separate Rust MDZ project: prior work, a comparison table, and the interoperability stance.