A Markdown flavor for inline, expandable references between sections of content.
Weave Markdown extends standard Markdown with:
- Section frontmatter — YAML metadata defining section identity
- Node links —
node:URL scheme for referencing sections - Weave format — Rich media, math (LaTeX), embeds, and voiceover
weave-md/
├── packages/
│ ├── core/ # Spec, schemas, types, pure helpers
│ ├── parse/ # AST generation
│ ├── validate/ # Document validation
│ └── basic/ # CLI + rendering + export
├── conformance/ # Normative test corpus
├── examples/ # Non-normative demos
└── tests/
pnpm install && pnpm build # Install and build
pnpm test # Run testsweave-md-basic export html --entry=intro # Export to HTML
weave-md-basic export ast # Export to JSON ASTSee @weave-md/basic for more CLI options.
| Package | Description |
|---|---|
| @weave-md/core | Language contract — spec, schemas, types, pure helpers |
| @weave-md/parse | AST generation (markdown → WeaveAst) |
| @weave-md/validate | Document validation for editors/CI |
| @weave-md/basic | Reference implementation — CLI, rendering, export |
The normative spec lives in packages/core/spec/: Overview · Node Links · Frontmatter · Weave Format · Conformance
Conformance tests in conformance/ define correct behavior.
- This repo:
@weave-md/core,@weave-md/parse,@weave-md/validate,@weave-md/basic - Separate:
vscode-weave-md(VS Code extension)
Version 0.1.0-alpha — APIs and spec subject to change.
MIT