作品接入指南

基础模式无需任何文件;增强模式在项目里放一份可选配置,内容更丰富。

基础模式(默认)

仓库默认隐藏。你在管理页把它设为展示后,网站读取 GitHub 事实(名称、 Description、Topics、语言、License、Stars)和安全渲染的 README 作为内容, 版本与附件来自 GitHub Releases。你不需要在本仓库做任何改动。

增强模式(可选)

在项目默认分支创建 .portfolio/portfolio.json,校验通过后按字段覆盖基础内容; 校验失败不会影响已有展示。文件不影响发布状态:展示、精选与排序始终由管理页决定。

容量与约束

配置 ≤ 32 KiB;增强正文 ≤ 128 KiB;
单图 ≤ 2 MiB,截图合计 ≤ 8 MiB,仅支持 .portfolio/assets/ 下的 png/jpg/webp;
只描述已实现并能证实的能力,不确定的内容留空,不虚构。

最小配置

{
  "schemaVersion": 1
}

完整示例(需替换为真实资料)

{
  "$schema": "https://posase.im/api/portfolio/schema/v1.json",
  "schemaVersion": 1,
  "title": "项目真实名称",
  "summary": "基于实际代码和 README 描述项目用途。",
  "bodyFile": ".portfolio/overview.md",
  "features": [
    "已经实现并能证实的功能"
  ],
  "techStack": [
    "TypeScript"
  ],
  "links": {
    "docs": "https://example.com/docs"
  },
  "cover": {
    "path": ".portfolio/assets/cover.webp",
    "alt": "真实项目界面的概览"
  }
}

复制提示词,在项目本地交给 AI

也可以直接访问 /api/portfolio/prompt.txt 获取纯文本。

请读取 https://posase.im/api/portfolio/spec.json 及其 v1 Schema,
分析当前项目的真实代码、README 和可运行界面,为我的作品网站生成可选增强资料。
按规范创建 .portfolio/portfolio.json,必要时创建 .portfolio/overview.md
和 .portfolio/assets/ 中的真实截图或明确标注为示意的素材。
只描述已实现并能证实的能力;无法运行截图时省略截图,不虚构效果。
字段允许省略,不确定的文案、网址和素材不要编造。
不要写展示开关、精选、排序、slug、版本、发布日期、Release Notes 或发布附件链接;
发布设置由网站管理页决定,版本与附件由网站读取 GitHub Releases。
只有项目确有特殊外部下载渠道时才填写 additionalDownloads。
最后校验配置,列出生成文件、资料依据和仍需人工核实的地方。
若无法获取规范,请报告原因,不要猜测协议或自动提交、推送、发布。

Schema 与规范目录: https://posase.im/api/portfolio/schema/v1.json · /api/portfolio/spec.json