The MDZip project

MDZip is an open format project with a specification, core libraries, and reference tools. This page summarizes the implementation layout and repository map.

Project scope

  • Define and maintain the MDZip format specification.
  • Provide reusable core libraries for archive reading/writing and validation.
  • Ship reference tools that exercise the spec in practical workflows.
  • Keep behavior interoperable across platform and web ecosystems.

Release status

Latest release and package status for MDZip repositories.

Specification

GitHub Repo Description Release Package
mdzip-spec .mdz format specification. All other repos ultimately refer to this. Latest release for mdzip-spec —

Core libraries

GitHub Repo Description Release Package
mdzip-core Platform (OS/runtime) .mdz core library (C#/.NET). Latest release for mdzip-core NuGet package version for MDZip.Core
mdzip-core-js JavaScript .mdz core library (@mdzip/core-js, TypeScript, browser + Node.js). Latest release for mdzip-core-js NPM package version for @mdzip/core-js

App libraries

GitHub Repo Description Release Package
mdzip-editor @mdzip/editor, framework-independent MDZip workspace engine and browser view. Latest release for mdzip-editor NPM package version for @mdzip/editor
mdzip-editor @mdzip/editor-react, React wrapper for the MDZip workspace editor. Latest release for mdzip-editor NPM package version for @mdzip/editor-react
mdzip-editor @mdzip/editor-vue, Vue wrapper for the MDZip workspace editor. Latest release for mdzip-editor NPM package version for @mdzip/editor-vue
mdzip-editor @mdzip/editor-ng, Angular UI components for the MDZip workspace engine. Latest release for mdzip-editor NPM package version for @mdzip/editor-ng

Applications & Extensions/Plugins

GitHub Repo Description Release Package
mdzip-cli Platform (OS/runtime) CLI for create/extract (C#/.NET). Latest release for mdzip-cli —
mdzip-vscode VS Code custom editor and included MCP server for reading and writing .mdz files, including packaged images. Latest release for mdzip-vscode MDZip on the VS Code Marketplace
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. Latest release for mdzip-studio Download for Windows Download for Linux
mdzip-google-voice-exporter Userscript — exports a Google Voice conversation to .mdz. Latest release for mdzip-google-voice-exporter —

Architecture and dependency flow

The project separates format definition, reusable core logic, and end-user tools.

Current state

  • Specification exists and is publicly versioned.
  • mdzip-core (C#/.NET) and @mdzip/core-js (TypeScript) are both active for platform and web runtimes.
  • mdzip-cli is available as the cross-platform reference CLI.
  • The MDZip editor library is now published as a family of scoped packages under the @mdzip npm organization: @mdzip/editor (framework-independent engine), @mdzip/editor-react, @mdzip/editor-vue, and @mdzip/editor-ng.
  • mdzip-vscode is available on the VS Code Marketplace as "MDZip (.mdz) Editor" and supports packaged images plus included MCP workflows.
  • This site's browser viewer and packager demos use @mdzip/core-js for shared archive behavior.
  • The Studio page preview is rendered by the published @mdzip/editor library itself, so it exercises the real editor — including progressive image hydration — rather than a static mockup.
  • MDZip Studio is available for Windows and Linux as a desktop Markdown editor with native .mdz support, standalone .md editing, folder packing, manifest editing, archive validation, manual and background update checks, and file-type registration (plus a File Explorer preview on Windows). macOS is coming soon.