TypedMark

Audience: everyone.

See also:

• Manifesto: the motivation for TypedMark
• Getting Started: a non-normative first collection
• Foundations: the first normative specification page

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 Core Profile 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: collection configuration plus portable queries, reusable datasets, and saved table, list, cards, and board views
• 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, plus compatibility and conversion between fields
• Managed Notes and Properties: what a typed note must look like on disk, including automation execution and dependency propagation
• Note Links: how links between notes are written and resolved
• Relationships, Headings, Templates, and Content Expansion: documenting how note types relate, what a note's body must contain, how template-owned regions drift, and how derived Markdown stays synchronized
• 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#

Core Profile — the shortest conforming path:

1. Manifesto
2. Getting Started
3. Foundations
4. Collection Model for typedmark.md identity and defaults
5. Note Type Schemas for one concrete note type and the effective schema
6. Managed Notes and Properties, with the Field Definition Reference at hand
7. Note Links and Relationships, Headings, Templates, and Content Expansion when the collection needs links, headings, template drift tracking, or synchronized derived Markdown

Essentials plus reuse — for larger personal or team collections:

8. Collection Model sections on property sets, vocabularies, advanced note-type mappings, portable queries, datasets, and saved views
9. Note Type Schemas sections on abstract inheritance, conditions, counts, and storage variations

Advanced — for publishing, composing, and migrating systems:

10. Systems, Composition, and Evolution
11. Migration Effects

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

12. Conformance and Roadmap
13. 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