Sitemap

Every page on MDZip.org. For search engines, the same list is at sitemap.xml.

Main pages

  • Home
    MDZip (.mdz) is a portable, cross-platform format that packages Markdown documents, images, and metadata into one archive. Learn the format, spec, and tools.

Learn

  • The Problem
    Why multi-file Markdown documents break when shared: images and attachments get lost between tools, how tools handle images today, and what a fix must do.
  • Format Details
    Technical details of the MDZip (.mdz) format: archive layout, minimum valid archive, manifest metadata, entry-point resolution, assets, links, and security.
  • Specification
    The MDZip (.mdz) specification, mirrored from its repository: archive structure, manifest file, Markdown content and assets, linking, MIME type, and versioning.
  • MDZip (.mdz) FAQ
    Answers to common questions about the MDZip (.mdz) format: why it exists, how it compares to EPUB and ZIP, what it can hold, security, and Markdown support.
  • MDZip (.mdz) and AI: What AI-Friendly Means
    What it means for MDZip (.mdz) to be AI-friendly: plain Markdown and images in one ZIP, self-describing, predictable, easy to produce, safe to open.

Get MDZip

  • MDZip (.mdz) Tools
    Official MDZip (.mdz) tools: the MDZip Studio desktop app, the mdz CLI, the VS Code extension, the web editor and packager, and JavaScript and .NET libraries.
  • What Works with MDZip (.mdz)
    See what MDZip works with at a glance: Windows, Linux, macOS, your browser, VS Code, Cursor and VSCodium, AI agents, Obsidian, JavaScript, .NET and more.
  • Editor Demo
    Try the MDZip workspace editor in your browser: open, edit, and preview .mdz archives and Markdown files in its JavaScript, Angular, Vue, and React builds.
  • Folder to .mdz Packager
    Package a folder of Markdown and assets into an MDZip (.mdz) archive in your browser: choose the entry document, check the analysis, then download or open it.
  • MDZip (.mdz) Demos
    Hands-on MDZip demos: make an .mdz by zipping and renaming a folder, open it in the browser editor, package a repo online, and export Google Voice chats.

Developers

  • MDZip Documentation
    Guides and references for the MDZip (.mdz) format: getting started, the mdz CLI, the embeddable editor and its framework wrappers, AI guidance, related formats.
  • MDZip core libraries for .NET, JavaScript, Python, Rust and Lua
    Choose an MDZip core library for .NET, JavaScript, Python, Rust or Lua. Compare runtimes and availability, install a package and read your first MDZip archive.
  • 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.
  • MDZip Conformance Guide for App Developers
    What MDZip 1.2.0 requires of apps that open, create or save .mdz files, and what is optional: checklists, sample files, tests, and how to get your app listed.

Project

  • About MDZip: Mission and Principles
    Why the MDZip (.mdz) project exists, the principles behind it (spec first, open source, no gatekeepers) and who's behind it.
  • The MDZip Project
    An overview of the MDZip project: what it covers, the release status of each tool, how the format, libraries, and apps depend on each other, and current state.
  • Contribute
    Help MDZip grow: star and rate the apps, tell people about it, send feedback, build something that reads or writes .mdz, or contribute code.
  • Help Test MDZip
    Follow a short test script for an MDZip (.mdz) app on your computer and post what worked and what didn't. No coding needed.
  • Share Links
    Find and copy short, lasting MDZip links for email, posts and bookmarks. Share Obsidian, Lua, VS Code, MDZip Studio, the specification and Getting Started.

Docs

  • Documentation home
    Guides and references for the MDZip (.mdz) format: getting started, the mdz CLI, the embeddable editor and its framework wrappers, AI guidance, related formats.
  • 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.
  • Refine a user story with AI
    Bring an Azure DevOps or GitHub story into an .mdz, refine it with an AI assistant in VS Code through two MCP servers, and send the result back to the tracker.
  • Using MDZip with Git, GitHub and Azure DevOps
    Use MDZip (.mdz) files in Git, GitHub and Azure DevOps: keep Markdown as the source, read diffs with mdz textconv, and check and package them in CI pipelines.
  • 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.
  • Encrypting .mdz Files
    How to password-protect an .mdz file and keep it valid: encrypt the whole file with 7-Zip or age, or seal it in an envelope that explains how to open it.

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.
  • @mdzip/editor JavaScript Guide
    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.
  • @mdzip/editor-ng Angular Guide
    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.
  • @mdzip/editor-react React Guide
    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.
  • @mdzip/editor-vue Vue Guide
    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.

More docs

  • Add MDZip to Your App
    How to add .mdz support to your Markdown editor or note app, step by step: libraries for JavaScript and .NET, tested code for opening, exporting and saving, and ready-made prompts for AI coding assistants.
  • MDZip Conformance Guide for App Developers
    What MDZip 1.2.0 requires of apps that open, create or save .mdz files, and what is optional: checklists, sample files, tests, and how to get your app listed.
  • 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.

News

More pages

Pages the menu doesn't link to directly.

  • Browser warnings on .mdz
    Why browsers and email clients warn about .mdz downloads (an old Microsoft Access extension shares the name), where it happens, and how to work around it.
  • Google Voice Chat Exporter
    Save a Google Voice conversation, with its photos, senders and timestamps, as one MDZip (.mdz) file you can keep, print or share.
  • How Others Handle Images
    A sample MDZip (.mdz) package of research notes on how Markdown tools and formats handle images, with comparison material. Download it or open it online.
  • How these pages are made
    How mdzip.org pages are made: written in Markdown, saved as a self-contained .mdz, previewed, and published, so each page is also a file you can download.
  • MDZip (.mdz) Editor
    Open and preview MDZip (.mdz) archives in your browser: drag and drop a file, read its documents and images, and download it again. No install or account.
  • MDZip Editor for VS Code
    Edit .mdz files in VS Code with live preview, packaged images, templates, Git diffs and an MCP server for AI agents.
  • MDZip for Obsidian
    Open and edit .mdz files in Obsidian, keep pasted images inside the note, and link, graph and search across archives and your vault.
  • MDZip Studio
    MDZip Studio: a lightweight Markdown editor with native .mdz support for Windows, macOS and Linux, with a File Explorer preview on Windows.
  • Test Script: MDZip Studio on Mac
    Step-by-step test script for MDZip Studio on macOS: install, open .mdz files from Finder, edit, paste pictures, Mac menus and the Dock, then post your results.
  • Use .mdz Today
    How to open, register and create .mdz files today: with MDZip Studio, VS Code or the web editor, or with the ZIP and Markdown tools already on your computer.