Submit

Add a design to the directory.

Four ways to get a DESIGN.md added — pick whichever maps to where you are.

01 · You already have one.

CLI submit

Run design-md submit ./DESIGN.md — auto-forks the catalog repo, opens a PR for you. Requires the gh CLI installed and authed. The fastest path if you have a working DESIGN.md.

See command docs →
02 · You have a URL.

Auto-extract

Run npx @webdesignhot/design-md extract https://yoursite.com — get a draft DESIGN.md back in 30 seconds. Review it, tweak the lineage prose, then submit.

Try the extractor →
03 · You have a vibe.

Chat-build

Describe the feeling — "warm editorial broadsheet", "neon arcade", "swiss grid" — chat agent walks you through the tokens. Live preview renders as you talk.

Open the chat →
04 · You prefer git CLI.

Manual PR

Fork github.com/WebDesignHot/design-md, add your file at design-md/<slug>.md, open a PR against main. Our GitHub Actions auto-lints and posts results in the PR.

Open a PR →
Quick start

Already have a DESIGN.md in your repo? One command and we'll auto-fork + open a PR for you:

$ npx @webdesignhot/design-md submit ./DESIGN.md

✓ Lint passed
→ Submitting Linear as slug "linear"
→ Forking WebDesignHot/design-md to your-username/design-md
→ Branch: submit/linear-x4f2
→ Pushing to your-username/design-md:submit/linear-x4f2
→ Opening PR

✓ Submitted.
  https://github.com/WebDesignHot/design-md/pull/47

Your design will appear on webdesignhot.com once we review and merge.

Requires gh (GitHub CLI) installed and authed: brew install gh && gh auth login.

What we accept

  • Real production sites' design systems (your own product, not a competitor's).
  • Open-source design systems (Tailwind UI, shadcn/ui themes, Material variants).
  • Editorial templates with named lineage and Do's & Don'ts.
  • Token swaps of existing entries with cosmetic changes only.
  • Submissions that don't pass design-md lint.

Before you submit

  1. Run design-md lint <file> locally; fix all errors.
  2. Add a lineage block — 200 words explaining what it draws from. We won't accept Mad-Libs prose.
  3. Add a preview_swatch array of 3 hexes for the card meta strip.
  4. Tag categories + tags using the existing taxonomy (see /spec).