Skip to content

Commit 04d8ea1

Browse files
hqhq1025hqhq1025
authored
docs: launch-ready marketing — README, website, SEO, AI-SEO, og:image (#40)
* docs: launch-ready README + website + SEO + AI-SEO + meta tags Part A — README marketing polish (EN + zh-CN): - Hero image placeholder + badge strip at top - "What is Open CoDesign?" punchy 80-word hook - Quick demo section with YouTube + GIF placeholders - Comparison table: Open CoDesign vs Claude Design vs v0 vs Lovable - Quickstart rewritten as numbered 3-step flow (download → BYOK → prompt) - "Built-in Anthropic-style design intelligence" section (anti-slop Skill) - Roadmap table with shipped ✅ vs coming 🔜 status - Star History chart - "Cite this project" block (citation template + CITATION.cff reference) Part B — Website hero + features: - hero.image added (placeholder /hero.png) - CTA buttons: "Download for macOS" + "Star on GitHub" + "Quickstart" - Features 8 items polished; coming-soon items marked clearly - Comparison table updated (Open CoDesign row first, Lovable added) - Social proof / testimonial placeholder block added - CTA section with two links Part C — SEO deepening (config.ts): - lang: 'en-US' added - og:site_name, og:image:width/height added - twitter:site @OpenCoworkAI added - Canonical URL link tag added - Keywords updated with high-value phrases: "Claude Design alternative", "open source AI design tool", "BYOK design app", "local-first design generator" - JSON-LD SoftwareApplication: name capitalised, operatingSystem expanded to include Linux, aggregateRating placeholder added, codeRepository field added - Nav: added Why / Features / Pricing links - Footer: links to Apache-2.0, Contribute, Issues - socialLinks: Twitter added Part D — AI-SEO: - llms.txt: expanded with shipped features, coming-soon section, differentiation facts in statement form - llms-full.txt: full rewrite with comparison table, architecture section, hard constraints, community links, citation block - CITATION.cff: new file at repo root for academic/industry citation Sitemap: VitePress built-in sitemap plugin already configured. robots.txt: existing Allow: / is correct, no change needed. Signed-off-by: hqhq1025 <1506751656@qq.com> * fix(website): remove placeholder aggregateRating from JSON-LD Signed-off-by: hqhq1025 <1506751656@qq.com> * fix(docs): remove broken YouTube TODO CTA from README Signed-off-by: hqhq1025 <1506751656@qq.com> * fix(website): per-page canonical URLs Replace global canonical pointing to site root with a per-page canonical generated in transformPageData. Search engines were treating /quickstart, /architecture, /roadmap, and the localized /zh pages as duplicates of the home page. Addresses Codex review on #40. Signed-off-by: hqhq1025 <1506751656@qq.com> * fix(docs): swap broken hero.png for placehold.co + existing og.svg Codex flagged README hero referencing website/public/hero.png which does not exist, so the primary visual rendered broken on GitHub and docs previews. Use placehold.co in both READMEs and point the VitePress hero at the existing /og.svg until a real screenshot lands. Signed-off-by: hqhq1025 <1506751656@qq.com> --------- Signed-off-by: hqhq1025 <1506751656@qq.com>
1 parent 1a5ebcd commit 04d8ea1

8 files changed

Lines changed: 533 additions & 260 deletions

File tree

‎CITATION.cff‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
cff-version: 1.2.0
2+
message: "If you reference Open CoDesign in a paper, article, or product comparison, please cite it as below."
3+
type: software
4+
title: "Open CoDesign"
5+
abstract: "Open-source desktop AI design tool. The open-source alternative to Anthropic Claude Design. Accepts natural-language prompts and produces HTML prototypes, PPTX slide decks, and PDF one-pagers. Multi-model BYOK (Anthropic, OpenAI, Gemini, DeepSeek, Ollama), local-first, Apache-2.0."
6+
authors:
7+
- name: "OpenCoworkAI"
8+
website: "https://github.com/OpenCoworkAI"
9+
repository-code: "https://github.com/OpenCoworkAI/open-codesign"
10+
url: "https://opencoworkai.github.io/open-codesign/"
11+
license: Apache-2.0
12+
version: "0.1.0"
13+
date-released: "2026-04-18"
14+
keywords:
15+
- "AI design"
16+
- "Claude Design alternative"
17+
- "open source"
18+
- "BYOK"
19+
- "local-first"
20+
- "Electron"
21+
- "prototype generator"
22+
- "multi-model"

‎README.md‎

Lines changed: 117 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -2,105 +2,159 @@
22

33
**简体中文**: [README.zh-CN.md](./README.zh-CN.md)
44

5-
> An open-source desktop app for designing with AI. Bring your own model, keep everything local.
5+
> Your prompts. Your model. Your laptop. The open-source alternative to Anthropic Claude Design.
66
7-
[Website](https://opencoworkai.github.io/open-codesign/) · [Quickstart](#quickstart) · [Contributing](./CONTRIBUTING.md) · [Security](./SECURITY.md) · [Code of Conduct](./CODE_OF_CONDUCT.md)
7+
[Website](https://opencoworkai.github.io/open-codesign/) · [Quickstart](#quickstart) · [Docs](https://opencoworkai.github.io/open-codesign/quickstart) · [Contributing](./CONTRIBUTING.md) · [Security](./SECURITY.md)
8+
9+
<p align="center">
10+
<img src="https://placehold.co/1200x600/E8E5DE/0E0E10?text=open-codesign+demo" alt="Open CoDesign — prompt to prototype (demo coming soon)" width="900" />
11+
<!-- Hero placeholder via placehold.co — real screenshot coming before launch -->
12+
</p>
13+
14+
<p align="center">
15+
<a href="https://github.com/OpenCoworkAI/open-codesign/releases"><img alt="GitHub release" src="https://img.shields.io/github/v/release/OpenCoworkAI/open-codesign?label=release&color=c96442" /></a>
16+
<a href="LICENSE"><img alt="License" src="https://img.shields.io/badge/license-Apache--2.0-blue" /></a>
17+
<a href="https://github.com/OpenCoworkAI/open-codesign/actions"><img alt="CI" src="https://img.shields.io/github/actions/workflow/status/OpenCoworkAI/open-codesign/ci.yml?label=CI" /></a>
18+
</p>
819

920
---
1021

11-
**Status**: Pre-alpha. We're building in public. Not usable yet.
22+
## What is Open CoDesign?
23+
24+
Open CoDesign turns a natural-language prompt into a polished HTML prototype, slide deck, or marketing asset — entirely on your laptop, with whichever AI model you already pay for. Think of it as Claude Design, minus the subscription lock-in, minus the cloud account, minus the single-model ceiling.
25+
26+
---
1227

13-
Open CoDesign turns natural-language prompts into HTML prototypes, slide decks, and marketing assets — all running on your laptop, with whichever AI model you bring. It's the open-source counterpart to Anthropic Claude Design, built around three convictions:
28+
## Quick demo (60 s)
29+
30+
_Demo video coming soon._
31+
32+
![Prompt to prototype in seconds](https://placehold.co/800x450/f5f0eb/c96442?text=Demo+GIF+coming+soon)
33+
<!-- Replace with real demo GIF before launch -->
34+
35+
---
1436

15-
1. **Your designs are yours.** Prompts, generated artifacts, and codebase scans live on disk. No mandatory cloud, no telemetry by default.
16-
2. **Your model, your bill.** Bring your own API key (Anthropic / OpenAI / Google / OpenAI-compatible relays). We don't proxy, we don't charge per token.
17-
3. **Your craft, amplified.** Generated work isn't a black box — every artifact ships with the parameters worth tweaking, the version history worth diffing, the design system worth reusing.
37+
## Why Open CoDesign?
38+
39+
| | **Open CoDesign** | Claude Design | v0 by Vercel | Lovable |
40+
|---|:---:|:---:|:---:|:---:|
41+
| Open source | ✅ Apache-2.0 | ❌ Closed | ❌ Closed | ❌ Closed |
42+
| Desktop native | ✅ Electron | ❌ Web only | ❌ Web only | ❌ Web only |
43+
| Bring your own key | ✅ Any provider | ❌ Anthropic only | ❌ Vercel only | ⚠️ Limited |
44+
| Local / offline | ✅ Fully local | ❌ Cloud | ❌ Cloud | ❌ Cloud |
45+
| Models | ✅ 20+ (Claude, GPT, Gemini, Ollama…) | Claude only | GPT-4o | Multi-LLM |
46+
| Version history | ✅ Local SQLite snapshots | ❌ | ❌ | ❌ |
47+
| Data privacy | ✅ 100% on-device | ❌ Cloud-processed | ❌ Cloud | ❌ Cloud |
48+
| Price | ✅ Free, token cost only | 💳 Subscription | 💳 Subscription | 💳 Subscription |
49+
50+
---
1851

1952
## Quickstart
2053

21-
Download the latest installer from the [GitHub Releases](https://github.com/OpenCoworkAI/open-codesign/releases) page.
54+
### 1. Download
2255

23-
| Platform | File | Notes |
24-
|---|---|---|
25-
| macOS (Apple Silicon) | `open-codesign-*-arm64.dmg` | See Gatekeeper note below |
26-
| macOS (Intel) | `open-codesign-*-x64.dmg` | See Gatekeeper note below |
27-
| Windows | `open-codesign-*-Setup.exe` | See SmartScreen note below |
28-
| Linux | `open-codesign-*.AppImage` | See AppImage note below |
56+
Get the latest installer from [GitHub Releases](https://github.com/OpenCoworkAI/open-codesign/releases):
2957

30-
**macOS — Gatekeeper warning (v0.1 is unsigned)**
58+
| Platform | File |
59+
|---|---|
60+
| macOS (Apple Silicon) | `open-codesign-*-arm64.dmg` |
61+
| macOS (Intel) | `open-codesign-*-x64.dmg` |
62+
| Windows | `open-codesign-*-Setup.exe` |
63+
| Linux | `open-codesign-*.AppImage` |
3164

32-
Because v0.1 installers are not notarized, macOS will block the double-click open. To run anyway:
65+
> **v0.1 note:** installers are unsigned. macOS: right-click → Open. Windows: More info → Run anyway.
66+
> Want a verified build? Compile from source — see [CONTRIBUTING.md](./CONTRIBUTING.md).
3367
34-
1. Right-click (or Control-click) the `.dmg` and choose **Open**.
35-
2. In the dialog that appears, click **Open** again.
68+
### 2. Add your API key
3669

37-
You only need to do this once per install.
70+
First launch opens the Settings page. Paste any provider key:
3871

39-
**Windows — SmartScreen warning (v0.1 is unsigned)**
72+
- Anthropic (`sk-ant-…`)
73+
- OpenAI (`sk-…`)
74+
- Google Gemini
75+
- Any OpenAI-compatible relay (OpenRouter, SiliconFlow, local Ollama)
4076

41-
Windows may show "Windows protected your PC". To proceed:
77+
Credentials stay in `~/.config/open-codesign/config.toml`, encrypted via Electron `safeStorage`. Nothing leaves your machine.
4278

43-
1. Click **More info**.
44-
2. Click **Run anyway**.
79+
### 3. Type your first prompt
4580

46-
**Linux — AppImage**
81+
Pick one of the eight built-in demos or describe your own. A sandboxed prototype appears in seconds.
4782

48-
```bash
49-
chmod +x open-codesign-*.AppImage
50-
./open-codesign-*.AppImage
51-
```
83+
---
84+
85+
## Built-in Anthropic-style design intelligence
5286

53-
> **Security note:** v0.1 binaries carry no code-signing certificate. Users who prefer a verified build can compile from source — see [CONTRIBUTING.md](./CONTRIBUTING.md). Code signing (Apple Developer ID + Windows Authenticode) is planned for Stage 2.
87+
Generic AI tools produce generic output. Open CoDesign ships with a built-in **anti-AI-slop design Skill** — a curated instruction set that steers the model toward considered typography, purposeful whitespace, and meaningful color, not `#3B82F6` blue buttons on every artifact.
5488

55-
## Why Open CoDesign
89+
The first version of this Skill is already in every generation. Before the model writes a line of CSS, it reasons through layout intent, design system coherence, and contrast — the same editorial discipline behind Claude Design's best outputs, available on any model you bring.
5690

57-
- **Multi-model, BYOK**: Anthropic, OpenAI, Gemini, DeepSeek, or any OpenAI-compatible relay (OpenRouter, SiliconFlow, DuckCoding, local Ollama). Switch the active provider in Settings.
58-
- **Local-first**: SQLite for design history, encrypted TOML for credentials. Never a cloud dependency.
59-
- **Lean**: Install size budget ≤ 80 MB. No bundled Chromium runtimes, no telemetry.
60-
- **Apache-2.0**: Real OSS. Fork it, ship it, sell it. Keep the NOTICE.
91+
Add a `SKILL.md` to any project to teach the model your own taste.
92+
93+
---
6194

6295
## What's working today
6396

64-
- Multi-provider onboarding — Anthropic, OpenAI, and any OpenAI-compatible relay, configured in Settings.
65-
- Prompt → HTML prototype, rendered in a sandboxed iframe.
66-
- AI-generated sliders: the model emits the design parameters worth tuning (color, spacing, font), you drag to refine.
67-
- Inline comments: click any element in the preview, leave a note, the model rewrites only that region.
68-
- HTML export, with inlined CSS.
69-
- Generation cancellation.
70-
- Settings tabs with per-provider API key management.
71-
- GitHub Release pipeline (unsigned v0.1 installers: macOS DMG, Windows EXE, Linux AppImage).
97+
- Multi-provider onboarding — Anthropic, OpenAI, and any OpenAI-compatible relay
98+
- Prompt → HTML prototype, rendered in a sandboxed iframe
99+
- AI-generated sliders: model emits the parameters worth tweaking (color, spacing, font); drag to refine
100+
- Inline comments: click any element in the preview, leave a note, model rewrites only that region
101+
- HTML export with inlined CSS
102+
- Generation cancellation
103+
- Settings with per-provider API key management
104+
- GitHub Release pipeline (macOS DMG, Windows EXE, Linux AppImage)
72105

73-
## What's coming next
106+
---
74107

75-
- **Cost transparency**: token estimate before you generate, weekly spend in the toolbar, budget warnings.
76-
- **Version snapshots + diff**: every iteration saved. Compare two versions side by side, roll back, fork.
77-
- **Codebase → design system**: point at a local repo — we extract Tailwind tokens, CSS vars, and W3C design tokens. Every subsequent generation respects them.
78-
- **Three-style exploration**: generate three variations in parallel and pick the one that fits.
79-
- **Skills system**: ships with a built-in anti-AI-slop design Skill; add your own `SKILL.md` to teach the model your taste.
80-
- **PPTX and PDF export**: 8–12 slides as editable PPTX; PDF via local Playwright — no Canva detour.
108+
## Roadmap
109+
110+
| Feature | Status |
111+
|---|---|
112+
| Multi-provider onboarding + Settings | ✅ Shipped |
113+
| Prompt → HTML prototype (sandboxed iframe) | ✅ Shipped |
114+
| AI-generated tunable sliders | ✅ Shipped |
115+
| Inline comment → AI patch | ✅ Shipped |
116+
| HTML export (inlined CSS) | ✅ Shipped |
117+
| Cost transparency (token estimate + weekly spend) | 🔜 Coming |
118+
| Version snapshots + side-by-side diff | 🔜 Coming |
119+
| Codebase → design system (token extraction) | 🔜 Coming |
120+
| Three-style parallel exploration | 🔜 Coming |
121+
| PPTX export | 🔜 Coming |
122+
| PDF export | 🔜 Coming |
123+
| Code-signing (Apple ID + Authenticode) | 🔜 Stage 2 |
124+
| Figma layer export | 🔜 Post-1.0 |
81125

82-
## Why "CoDesign"
126+
---
83127

84-
> CoDesign = collaborative design. The model proposes, you direct. We don't believe in single-shot magic — we believe in tight loops with the model where you stay in the driver's seat.
128+
## Star history
85129

86-
## Built on
130+
[![Star History Chart](https://api.star-history.com/svg?repos=OpenCoworkAI/open-codesign&type=Date)](https://star-history.com/#OpenCoworkAI/open-codesign&Date)
87131

88-
- Electron + React 19 + Vite 6 + Tailwind v4
89-
- pi-ai (multi-provider model abstraction)
90-
- better-sqlite3, electron-builder
132+
---
91133

92-
## Contributing
134+
## Cite this project
135+
136+
If you reference Open CoDesign in a paper, article, or product comparison, please use:
137+
138+
```
139+
OpenCoworkAI (2026). open-codesign: Open-source desktop AI design tool.
140+
GitHub. https://github.com/OpenCoworkAI/open-codesign
141+
Apache-2.0 License.
142+
```
143+
144+
Or the machine-readable `CITATION.cff` at the repo root.
145+
146+
---
93147

94-
Read [CONTRIBUTING.md](./CONTRIBUTING.md). The short version: open an issue before writing code, sign your commits with DCO, run `pnpm lint && pnpm typecheck && pnpm test` before opening a PR.
148+
## Built on
95149

96-
## CI
150+
- Electron + React 19 + Vite 6 + Tailwind v4
151+
- `@mariozechner/pi-ai` (multi-provider model abstraction)
152+
- `better-sqlite3`, `electron-builder`
97153

98-
PR / main pushes run lint + typecheck + test on ubuntu-latest (1-2 min feedback).
99-
Cross-platform builds happen on tag releases (`v*.*.*`) via `release.yml` (mac/win/linux).
154+
## Contributing
100155

101-
Local pre-push hook (auto-installed via `pnpm install`) runs typecheck + lint in seconds
102-
to fail fast before pushing.
156+
Read [CONTRIBUTING.md](./CONTRIBUTING.md). Open an issue before writing code, sign commits with DCO, run `pnpm lint && pnpm typecheck && pnpm test` before a PR.
103157

104158
## License
105159

106-
Apache-2.0
160+
Apache-2.0 — fork it, ship it, sell it. Keep the [NOTICE](./NOTICE).

0 commit comments

Comments
 (0)