ProtoML Documentation

ProtoML is a lightweight document language for meetings, protocols, task lists, reusable content, shared participants, shared tags, and structured exports.

The repository includes the parser, renderers, CLI tools, bundled macros, the Electron viewer, and Windows CHM help generation.

Start here

• Installation And Release Use
• Quick Start
• ProtoML Concepts
• Authoring Guide
• Reuse And Imports Guide
• Own Macro Registry Guide
• Macro Security And Trust Model
• Validation And Analysis Workflows
• Governance Documents
• Release And Packaging
• Examples Cookbook

By role

• Authors: Quick Start, Authoring Guide, Reuse And Imports Guide, Outputs And Rendering
• Macro users: Macros Guide, Reuse And Imports Guide, Own Macro Registry Guide, Macro Security And Trust Model, Examples Cookbook
• CLI users: CLI Reference, Outputs And Rendering, Validation And Analysis Workflows, Release And Packaging
• Viewer users: Viewer Guide
• Governance-focused users: Governance Documents, Validation And Analysis Workflows
• Users exploring the language surface: Reference Map

What lives where

• README.md for project overview, installation, quick start, and release structure
• docs/*.pml for built-in CLI help topics via protoparser --docs <topic>
• docs/chm/ for generated Windows CHM help project files and compiled output
• examples/ for runnable feature and macro-registry examples