Skip to content

3md documentation

3md is Markdown with a Z axis. A .3md file is ordinary Markdown stacked into planes along one named axis, and you tell the reader what the depth means: time for a planner, frames for an animation, layers for annotations, space for a scene. These docs cover the format, the viewer, the CLI, and the four libraries.

Getting started

  • What is 3md? - Markdown extended along one named Z axis: stack content into planes and say what the depth means.
  • Quickstart - Write your first .3md file and open it in the viewer in a few minutes.
  • Viewer and editor - Open files, rotate cubes, edit slices, load binary and composition examples, and keep your changes.

The format

  • The format - Frontmatter, the Z axis, @plane directives, attributes, and cross-plane links.
  • Embedding the web component - The <three-md> web component and its view modes (stack, play, map, blend, and more).

Reference

  • CLI reference - The threemd CLI: validate, info, html, links. Install with Homebrew.
  • Parsers and conformance - Swift, TypeScript, and Rust share the hosted text contract. GDScript is a Godot 4.7 addon, checked locally.
  • Specification - The authoritative 3md format specification.