shipfolio 1.0.10 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -40,14 +40,16 @@ No need to install `wrangler` or `vercel` CLI -- shipfolio calls them via `npx`
40
40
  ```bash
41
41
  npx shipfolio --scan ~/Projects
42
42
  npx shipfolio --scan ~/Projects --output ./my-site
43
+ npx shipfolio --scan ~/Projects --engine claude --deploy cloudflare --style dark-minimal --accent '#10b981'
44
+ npx shipfolio --scan ~/Projects --auto --no-pdf
43
45
  npx shipfolio --scan ~/Projects --no-pdf --no-preview
44
46
  ```
45
47
 
46
48
  The pipeline:
47
49
  1. Scans directories for git repos (and non-git projects with package.json, Cargo.toml, etc.)
48
- 2. Interactive interview: select projects, optionally merge related ones (e.g. web + mobile), enter personal info, pick theme/colors/font
50
+ 2. Interactive interview: select projects, optionally merge related ones (e.g. web + mobile), enter personal info, pick theme/colors/font, and optionally enrich key projects with case-study details
49
51
  3. Generates the site using your local AI engine
50
- 4. Builds, exports PDF, previews locally
52
+ 4. Builds, previews locally, exports PDF
51
53
  5. Deploys to Cloudflare Pages or Vercel
52
54
  6. Optionally creates a GitHub repo with a CI/CD workflow for auto-deploy on push
53
55
 
@@ -98,6 +100,11 @@ npx shipfolio preview --site ./shipfolio-site --port 3000
98
100
  | Flag | Description | Default |
99
101
  |---|---|---|
100
102
  | `-s, --scan <dirs...>` | Directories to scan for projects | Current directory |
103
+ | `-e, --engine <name>` | `claude`, `codex`, or `v0` | Auto-detect |
104
+ | `-d, --deploy <platform>` | `cloudflare`, `vercel`, or `local` | Prompted |
105
+ | `--style <theme>` | `dark-minimal`, `light-clean`, `monochrome`, or `custom` | Prompted |
106
+ | `--accent <hex>` | Accent color like `#10b981` | Prompted |
107
+ | `--auto` | Use safe defaults and skip prompts | `false` |
101
108
  | `-o, --output <dir>` | Output directory | `./shipfolio-site` |
102
109
  | `--no-pdf` | Skip PDF export | |
103
110
  | `--no-preview` | Skip local preview | |
@@ -144,7 +151,11 @@ npx shipfolio preview --site ./shipfolio-site --port 3000
144
151
 
145
152
  ### Project Merging
146
153
 
147
- When you have related projects (e.g. a web app and its mobile companion), shipfolio lets you merge them into a single portfolio entry. Tech stacks, commit histories, and READMEs are combined automatically.
154
+ When you have related projects (e.g. a web app and its mobile companion), shipfolio lets you merge them into a single portfolio entry. Tech stacks, commit histories, and READMEs are combined automatically, and update detection now tracks every merged project path instead of only the first one.
155
+
156
+ ### Featured Projects And Case Studies
157
+
158
+ You can mark projects as featured and optionally add richer case-study inputs such as audience, problem, solution, impact, evidence, and screenshot URLs. These fields are passed directly into the generation prompt so the resulting site can emphasize your strongest work instead of flattening every project into the same card style.
148
159
 
149
160
  ### Draft Recovery
150
161
 
@@ -243,14 +254,16 @@ npx shipfolio --scan ~/Projects
243
254
  ```bash
244
255
  npx shipfolio --scan ~/Projects
245
256
  npx shipfolio --scan ~/Projects --output ./my-site
257
+ npx shipfolio --scan ~/Projects --engine claude --deploy cloudflare --style dark-minimal --accent '#10b981'
258
+ npx shipfolio --scan ~/Projects --auto --no-pdf
246
259
  npx shipfolio --scan ~/Projects --no-pdf --no-preview
247
260
  ```
248
261
 
249
262
  流程:
250
263
  1. 扫描目录中的 git 仓库(也支持没有 git 但有 package.json、Cargo.toml 等的项目)
251
- 2. 交互式问答:选择项目、可选合并相关项目(如 web + mobile)、填写个人信息、选择主题/颜色/字体
264
+ 2. 交互式问答:选择项目、可选合并相关项目(如 web + mobile)、填写个人信息、选择主题/颜色/字体,并可为重点项目补充更完整的案例信息
252
265
  3. 调用本地 AI 引擎生成网站
253
- 4. 构建、导出 PDF、本地预览
266
+ 4. 构建、本地预览、导出 PDF
254
267
  5. 部署到 Cloudflare Pages 或 Vercel
255
268
  6. 可选创建 GitHub 仓库并配置 CI/CD workflow,实现 push 自动部署
256
269
 
@@ -301,6 +314,11 @@ npx shipfolio preview --site ./shipfolio-site --port 3000
301
314
  | 参数 | 说明 | 默认值 |
302
315
  |---|---|---|
303
316
  | `-s, --scan <dirs...>` | 扫描目录 | 当前目录 |
317
+ | `-e, --engine <name>` | `claude`、`codex` 或 `v0` | 自动检测 |
318
+ | `-d, --deploy <platform>` | `cloudflare`、`vercel` 或 `local` | 交互选择 |
319
+ | `--style <theme>` | `dark-minimal`、`light-clean`、`monochrome` 或 `custom` | 交互选择 |
320
+ | `--accent <hex>` | 强调色,如 `#10b981` | 交互选择 |
321
+ | `--auto` | 使用安全默认值并跳过问答 | `false` |
304
322
  | `-o, --output <dir>` | 输出目录 | `./shipfolio-site` |
305
323
  | `--no-pdf` | 跳过 PDF 导出 | |
306
324
  | `--no-preview` | 跳过本地预览 | |
@@ -347,7 +365,11 @@ npx shipfolio preview --site ./shipfolio-site --port 3000
347
365
 
348
366
  ### 项目合并
349
367
 
350
- 当你有关联项目时(如 web 端和 mobile 端),shipfolio 支持将它们合并为一个作品集条目。技术栈、提交历史和 README 会自动合并。
368
+ 当你有关联项目时(如 web 端和 mobile 端),shipfolio 支持将它们合并为一个作品集条目。技术栈、提交历史和 README 会自动合并;更新检测也会追踪所有被合并项目的路径,不再只看第一个目录。
369
+
370
+ ### 重点项目与案例信息
371
+
372
+ 你可以把项目标记为重点项目,并可选补充 audience、problem、solution、impact、evidence、screenshot URL 等案例信息。这些结构化字段会直接进入生成 prompt,让最终网站更容易突出真正重要的作品,而不是把所有项目都做成同一种平铺卡片。
351
373
 
352
374
  ### 草稿恢复
353
375