weave-md

Weave Markdown - Inline, expandable references for markdown.

This is an umbrella package that re-exports all @weave-md/* packages. For most use cases, we recommend installing the individual packages directly from the @weave-md organization.

Packages

| Package | Description | |---------|-------------| | @weave-md/core | Types, schemas, and language spec | | @weave-md/parse | Parse markdown to WeaveAst | | @weave-md/validate | Validate references and links | | @weave-md/basic | Reference implementation with CLI and renderer |

Installation

Install individual packages (recommended):

pnpm add @weave-md/core @weave-md/parse

Or install everything via this umbrella package:

pnpm add weave-md

Usage

// Import from individual packages (recommended)
import { parseWeaveDocument, compileToWeaveAst } from '@weave-md/parse';
import { extractNodeLinks } from '@weave-md/validate';
import type { Section, NodeRef } from '@weave-md/core';

// Or import from umbrella package (namespaced)
import { parse, validate, core, basic } from 'weave-md';

const ast = parse.parseWeaveDocument(markdown);
const { links, errors } = validate.extractNodeLinks(markdown);

Links

• GitHub
• npm org