mdz is a strict markdown dialect built for streaming, Svelte authoring, docs websites, and untrusted content. The same grammar serves multiple use cases:
- streaming output from LLMs and other live sources
- authoring with Svelte components, with an optional build-time preprocessor that compiles static usage to plain Svelte markup
- rendering TSDoc/JSDoc comments on docs websites with domain-specific behavior like backticked identifiers linkifying to API docs
- dynamic content from untrusted users, with granular control over enabled behaviors
mdz's predictable grammar means streaming never re-parses:
LLM output renders incrementally, and the infrequent corrections --
like an unclosed ** or a link resolving late -- are bounded, explicit opcodes.
The streaming design is derived from @pngwn's
ideas in this Bluesky thread
(pngwn.at), and other parts of the mdz design are
inspired by pngwn's MDsveX.
mdz takes after CommonMark and GFM, diverging where their rules fight streaming or carry avoidable complexity and ambiguity. For more see the docs.
AI disclosure: almost everything here was generated by machine agents except for the designs and intros. mdz is the result of 5+ years of prototyping ideas.
⚠️ This project is pre-stable: breaking changes are expected and some features (like attributes) are not yet implemented. Feedback is welcome!
