Viewer Guide

ProtoML now has two viewer paths: the Electron-based protoviewer and the browser-based independent viewer in web/index.html.

Independent browser viewer

The browser viewer gives you an editor, local file upload, drag-and-drop loading, in-browser preview, and HTML export without requiring Electron.

npm run build:web
protoparser viewer
protoparser viewer app "./meeting.pml"
protowebviewer "./meeting.pml"

Start the viewer

protoviewer "test.pml"
protoviewer "test.pml" dark

This is the fastest way to inspect the rendered shape of a document while you are still editing the source.

When to use the viewer vs. CLI rendering

Typical workflow

  1. Edit the .pml file
  2. Open it in protoviewer for local review
  3. Use protoparser when you need distributable output

Limits

Related guides