@turboplan/mdx-spec
v1.0.3
Published
The MDX dialect v0: frontmatter schema, allowed tags, and validation.
Readme
Turboplan
The dialect library behind Turboplan —
a plan format for collaborating technical teams, especially humans guiding coding
agents. A plan is a single .mdx file in your repo: plain Markdown plus a small
set of components for task boards, diagrams and file references.
@turboplan/mdx-spec
This package is the spec made executable: the frontmatter schema, the allowed tag set, and the parse / validate / project / mutate functions that operate on plan source. It's the low-level building block — most people want one of:
@turboplan/mcp— the local stdio MCP server, so your coding agent can read, validate, patch and comment on plans. Start here.- Documentation & the Claude Code / Codex plugin — what a plan looks like, and how to install the skill + MCP in one step.
Reach for this package directly when you're building your own tooling on the format.
import { parsePlan, validatePlan, outline } from '@turboplan/mdx-spec'
const result = validatePlan(source, { filename: 'myplan.mdx' })
if (!result.ok) console.error(result.issues)
const { title, headings, tasks, taskCounts } = outline(source)Mutations (mutate.ts) are minimal-diff — untouched bytes stay byte-for-byte
identical, so plans stay reviewable in git.
License
Apache-2.0 — Copyright 2026 Upgrowth Pty Ltd.
