File Format

Markdown Zip .mdz

A portable, open format for bundling Markdown documents, images, and metadata into a single ZIP archive.

What is a .mdz file?

A .mdz file is a standard ZIP archive with a .mdz extension, structured to contain one or more Markdown documents along with their associated assets and optional metadata — all in a single, self-contained file.

📦

Self-contained

All Markdown content, images, and linked assets are bundled together. No broken links, no missing files.

🔓

Open standard

Built on the widely supported ZIP format. Any ZIP tool can open, inspect, or extract a .mdz file.

📝

Plain text inside

The contents are plain Markdown — human-readable, version-control friendly, and renderable anywhere.

🔀

Portable

Share a single file via email, file storage, or any transfer method and the recipient gets everything they need.

⚙️

Extensible metadata

An optional manifest.json allows tools to store title, author, date, tags, and custom fields.

🌐

Ecosystem-friendly

Works with existing Markdown renderers, static site generators, and documentation tools with minimal adaptation.

Why .mdz?

Markdown is great for writing, but sharing a document with images and multiple files means sending a folder, a repo link, or a tarball — none of which are friendly to non-technical recipients. .mdz solves this — and even on a system with no knowledge of the format, the file remains immediately accessible: rename it to .zip, extract, and open the Markdown in any text editor.

📎

One file to share

Attach a single .mdz to an email or upload it anywhere. The recipient gets the complete document — no zip-then-rename, no folder compression ambiguity.

🔒

No vendor lock-in

Unlike proprietary formats (DOCX, Notion exports, Confluence backups), .mdz is plain text in a standard ZIP. Any tool can read it today and in ten years.

🗂️

Better than bare ZIP

A recognised extension and a defined layout give tools a contract to rely on — so renderers, editors, and converters can handle .mdz without guessing at the contents.

🛟

Works without dedicated support

On any system that can unzip files and open a text editor, a .mdz file is immediately useful. Rename it to .zip, extract, and read. No special software, no installation, no internet required.

Archive structure

A valid .mdz archive must contain at least one Markdown entry point (index.md) at the root. All other entries are optional but follow a predictable layout.

document.mdz
├── index.md       # required entry point
├── manifest.json  # optional metadata
├── chapter.md    # additional .md files
└── assets/        # recommended directory
    ├── images/
    └── styles/

Key files

Entry Required Description
index.md Yes The primary Markdown document and entry point for the bundle.
manifest.json No JSON metadata: title, authors, version, description, keywords, and more. When present, mdz and title are required fields.
assets/ No Recommended directory for images, styles, and other media referenced in Markdown files.
Additional .md files No Extra Markdown files linked from index.md, at any path within the archive.

The manifest.json file

Place a manifest.json at the archive root to provide structured metadata about the document bundle.

manifest.json JSON
{
  "mdz": "1.0",
  "title": "My Project Documentation",
  "description": "Full reference for the Acme Widget SDK.",
  "author": "Jane Smith",
  "created": "2026-03-01",
  "modified": "2026-03-08",
  "version": "1.2.0",
  "language": "en",
  "tags": ["documentation", "sdk", "reference"],
  "entry": "index.md"
}

Create your first .mdz file

Because .mdz is a ZIP archive, you can create one with any standard ZIP tool — no special software required.

The minimum conforming .mdz file is just an index.md inside a ZIP archive with the extension renamed to .mdz. Everything else is optional.

  1. Write your Markdown Create an index.md file with your document content using standard Markdown syntax.

  2. Add a manifest (optional) Create a manifest.json with title, author, and other metadata you want to include.

  3. Gather assets Place any referenced images or other media in an assets/ subdirectory and update your Markdown image paths accordingly.

  4. Zip it up Compress the files into a ZIP archive and rename the extension from .zip to .mdz.

Command line (Linux / macOS) Shell
# Create the directory structure
mkdir -p my-doc/assets

# Write your document
echo "# Hello World" > my-doc/index.md

# Add an image
cp photo.png my-doc/assets/photo.png

# Zip and rename to .mdz
cd my-doc && zip -r ../my-doc.mdz . && cd ..
Command line (Windows PowerShell) PowerShell
# Create structure
New-Item -ItemType Directory my-doc\assets

# Write your document
"# Hello World" | Out-File my-doc\index.md

# Compress to .mdz
Compress-Archive -Path my-doc\* -DestinationPath my-doc.mdz

Ready to dive deeper?

Read the full specification for a complete reference of all fields, validation rules, and MIME type registration.