TypedMark

TypedMark is an open specification for typed Markdown note systems.

New here? Read the Manifesto for the why, then follow Getting Started to build your first typed collection in five minutes. The Quick Reference maps terms and everyday tasks to the rules that govern them.

The Pages#

• Manifesto: why note types matter
• Getting Started: your first typed collection, step by step (non-normative)
• Foundations: the core concepts, the file format of governed artifacts, and the parsing baselines everything else builds on
• Collection Model: the collection configuration file — how notes get their types, and how shared structure is reused
• Note Type Schemas: how one note type is defined — its fields, storage location, naming, and constraints
• Field Definition Reference: every property a field can declare, from types to constraints to generated values
• Managed Notes and Properties: what a typed note must look like on disk
• Note Links: how links between notes are written and resolved
• Relationships, Headings, and Templates: documenting how note types relate, and what a note's body must contain
• Systems, Composition, and Evolution: packaging a collection as a shareable, versioned, composable system
• Migration Effects: what happens to existing notes when a system changes
• Conformance and Roadmap: what it means for a tool or collection to conform
• Quick Reference: glossary and "how do I…" index (non-normative)

Reading Paths#

Essentials — enough to build and maintain a typed collection:

1. Manifesto
2. Getting Started
3. Foundations
4. Collection Model
5. Note Type Schemas
6. Managed Notes and Properties, with the Field Definition Reference at hand
7. Note Links and Relationships, Headings, and Templates

Advanced — for publishing, composing, and migrating systems:

8. Systems, Composition, and Evolution
9. Migration Effects

Tool authors — for implementing validators, importers, and editors:

10. Conformance and Roadmap
11. The parsing and matching baselines in Foundations and the machine-readable schemas

Machine-Readable Schemas#

The governed artifacts have machine-readable JSON Schemas, fixtures, and a boundary document under schema/. The prose specification remains the single source of truth.

Related Repositories#

• TypedMark: the tooling, website, and documentation around the specification
• TypedMarkExample: a concrete system example built on this specification
• TypedMarkSystemsMarketplace: the systems marketplace, hosting systems, a browsing and composition website under docs/, and the marketplace.json catalog of known systems defined by this specification