Demos
Hands-on examples for creating, packaging, and rendering .mdz archives.
No-tools demo (ZIP + rename)
Create an .mdz without CLI or web tooling:
- Create a folder with at least one root-level Markdown file.
- Add any referenced assets (images, stylesheets, etc.).
- Compress the folder's contents into a
.ziparchive: select the files inside the folder, not the folder itself, so the Markdown file sits at the root of the archive. - Rename
.zipto.mdz.
Example folder:
my-doc/
├── MyFile.md
└── assets/
└── image.png
You now have a portable, self-contained file of Markdown content and its associated assets. You can send it somewhere and reverse the process to view it. Or, if you want to view it online...
Editor demo
Use the browser editor to open and navigate an archive.
- Open: editor-demo.html
- Drag-and-drop an
.mdzfile (like the one you just created above), or use Open → Choose file.... The Open menu also has sample files to try.
What to check:
- entry-point resolution (in the nav pane the entryPoint file will have a blue dot)
- internal Markdown links
- image rendering paths
- multi-file navigation behavior
More complex example: package a large Markdown repo
Goal: package a real multi-file dataset into one archive and render it in the editor.
Overview
- Clone the sample content repository (works better on Linux/Mac because the repo has filename characters that Windows doesn't like, requires git)
- Install the CLI
- Create an archive from that dataset
- Validate and list files.
- Open the resulting archive in the Editor Demo page on this site
Commands (bash or PowerShell):
# Get the books dataset (a BUNCH of .md files, no images? requires git)
# Mac/Linux
git clone https://github.com/mlschmitt/classic-books-markdown
# Windows (will skip a few books with filenames Windows doesn't like)
git clone -c core.protectNTFS=false https://github.com/mlschmitt/classic-books-markdown
# Get the Command Line Interface
# Mac/Linux
curl -fsSL https://raw.githubusercontent.com/mdzip-project/mdzip-cli/main/scripts/install.sh | sh
# Windows
winget install MDZip.Cli
# Windows without WinGet (PowerShell)
irm https://raw.githubusercontent.com/mdzip-project/mdzip-cli/main/scripts/install.ps1 | iex
# Create the .mdz file
mdz create ./classic-books-markdown books.mdz
# For fun, validate and list contents
mdz validate books.mdz
mdz ls books.mdz # Tree format
mdz ls books.mdz -l # Long format
Then drag and drop the books.mdz file into the Editor Demo and inspect navigation/performance with many files.
Package online (web packager demo)
Demonstrates packaging in-browser (backed by web tooling around @mdzip/core-js).
- Open the Packager page.
- Drag a folder containing at least one Markdown file (could use the books repo folder created above)
- Build the archive.
- Download the
.mdzfile or open directly in the Editor Demo.
Real-world example: Google Voice Chat Exporter
Not a tutorial: an actual tool built on .mdz, in daily use.
The Google Voice Chat Exporter is a browser userscript
that saves an open Google Voice conversation (text, timestamps, photos) as one
.mdz file, entirely in the browser, using @mdzip/core-js.
Worth a look if you want to see .mdz produced by a real app outside this
site's own tooling, not just packaged from a folder.
Install it and see what it makes.
Core actions to validate in each demo
- Package source files into a valid
.mdz. - Render
.mdzin browser editor/viewer. - Verify links and assets resolve as expected.
Example workflows / use-cases
- Word replacement: long-form docs with images in one portable file.
- Single web page handoff: share one self-contained package for review.
- Multi-page docs package: versioned per release.
- Team handoff package: Markdown + screenshots + diagrams in one archive.
This page renders from demos.mdz (MDZip, ~4 KB, updated 2026-11-10) — one self-contained file. Download it, open it in the web editor, or read how these pages are made.