Write design system notes and tokens in one Markdown file. Use designmd to lint that file and export tokens to CSS.

Run with npx

npx --yes @shanepadgett/design.md --help

Validate a design file

npx --yes @shanepadgett/design.md lint DESIGN.md

Treat warnings as failures:

npx --yes @shanepadgett/design.md lint --strict DESIGN.md

Export tokens

Export CSS custom properties:

npx --yes @shanepadgett/design.md export --format css --out design-tokens.css DESIGN.md

Export Tailwind-friendly CSS:

npx --yes @shanepadgett/design.md export --format css-tailwind --out theme.css DESIGN.md

Use --force to overwrite an existing output file.

Migrate legacy files

Preview migration output:

npx --yes @shanepadgett/design.md migrate DESIGN.md

Update the file in place:

npx --yes @shanepadgett/design.md migrate --write DESIGN.md

Print the spec

Print the full human-readable spec:

npx --yes @shanepadgett/design.md spec

Print the compact agent-oriented spec:

npx --yes @shanepadgett/design.md spec --agent

Library API

import { exportDesignMd, lintDesignMd, parseDesignMd } from "@shanepadgett/design.md";

Contributing

See CONTRIBUTING.md.