Markdown, images, and metadata in one portable file.
MDZip bundles one or more Markdown documents and their assets into a single .mdz file. Share a document with its images, move it between tools, or distribute a collection of linked pages without keeping a folder of files together.
An .mdz file is a ZIP archive with a structure defined by an open specification. The Markdown stays readable, and the archive can be inspected with ordinary ZIP tools.
Visit MDZip.org · Read the Specification
| What you want to do | Where to go |
|---|---|
| Write and manage documents in a desktop app | MDZip Studio |
Work with .mdz files in VS Code |
VS Code extension |
| Create and extract archives from the command line | mdz CLI |
| Add MDZip support to your software | JavaScript / TypeScript or C# / .NET core libraries |
| Embed a Markdown and MDZip editor | Editor packages for JavaScript, Angular, React, and Vue |
| Implement or understand the file format | Format specification and examples |
Explore the source, find a release, or open the published package. Each repository documents its own installation and usage.
| Repository | Description | Release | Package |
|---|---|---|---|
| mdzip-spec | .mdz format specification. All other repos ultimately refer to this. |
 |
— |
| Repository | Description | Release | Package |
|---|---|---|---|
| mdzip-core | C# / .NET library for working with .mdz archives (MDZip.Core). |
 |
 |
| mdzip-core-js | JavaScript .mdz core library (@mdzip/core-js, TypeScript, browser + Node.js). |
 |
 |
| Repository | Description | Release | Package |
|---|---|---|---|
| mdzip-editor | @mdzip/editor, framework-independent MDZip workspace engine and browser view. |
 |
 |
| mdzip-editor | @mdzip/editor-react, React wrapper for the MDZip workspace editor. |
|
 |
| mdzip-editor | @mdzip/editor-vue, Vue wrapper for the MDZip workspace editor. |
|
 |
| mdzip-editor | @mdzip/editor-ng, Angular UI components for the MDZip workspace engine. |
|
 |
| Repository | Description | Release | Package |
|---|---|---|---|
| mdzip-cli | mdz CLI for creating and extracting .mdz archives (C# / .NET). |
 |
— |
| mdzip-vscode | VS Code custom editor and bundled MCP server for reading and writing .mdz files, including packaged images. |
 |
 |
| mdzip-studio | Cross-platform desktop/web application for MDZip authoring and management. The Windows install adds a File Explorer shell extension with .mdz preview and registration. |
 |
 |
Report a bug or propose a feature in the repository for the tool or library you use. For format questions and proposals, use the specification repository.
Working across repositories? This .github repository holds the workspace manifest, hub architecture, and agent instructions. Cross-repository work is tracked through linked issues in the repositories that own the changes.