快速入门
从注册到获得私有预览 URL,只需约 5 分钟。
本指南带你从注册开始,获得一个私有预览 URL。第 2 步有两条路径, 请根据手头是否已有 GitHub 仓库选择。
1. 创建您的工作区
前往/login登录。支持邮箱和密码、GitHub、Google 三种方式。 首次登录时,Showly 会创建一个以你的账号命名的工作区,之后可在 工作区设置中重命名。
新工作区默认使用 Free 套餐,正式站点和智能体连接均不限量, 足以完成本指南。当前积分、域名和功能差异见定价页面。
2. 添加站点:选择一种方式
您可以从模板开始(不需要存储库)或连接现有的 GitHub 存储库。
A. 从模板开始(更快,无需 GitHub)
打开/onboarding/from-template。当前提供 以下 5 个起始模板:
- SaaS 落地页 — 单页营销网站(Next.js)
- 文档站点 — Markdown 驱动的文档页面(Next.js)
- 作品集 — 包含“关于”和“项目”区块的个人网站(Next.js)
- Astro 文档 — 内容优先的文档模板(Astro)
- Vite + React 落地页 — 单页应用外壳(Vite + React)
选择模板,填写变量表单(site_slug、项目和模板专属选项)后提交。 Showly 会创建站点、生成模板文件并启动首次构建,然后进入显示构建 状态的站点详情页。
这是获得预览 URL 的最快方式:无需 GitHub OAuth,无需额外安装,也 无需等待 Webhook。
B. 连接存储库
在工作区主页点击连接站点并选择 GitHub 仓库。首次连接时, GitHub 会要求授权 Showly GitHub App;权限说明见 你的第一个站点。 授权后,Showly 会按需读取 package.json、锁文件和框架提示等仓库 元数据,用于:
- 检测框架(Astro、Vite、Next.js 导出或静态 HTML)
- 提出构建命令和输出目录
确认建议的站点清单;继续前可以修改任何字段。
两条路径在步骤 3 处汇聚。
3. 连接智能体(可选但推荐)
在智能体中注册 Showly MCP 服务器:
npx @showly/mcp-server install --to claude-code # or --to codex
无需再复制令牌。首次调用 Showly 工具时,智能体会打开浏览器,让你 登录并批准访问;随后 Showly 会直接签发带作用域的令牌。授权握手和 无浏览器环境的备用流程见安装 Skill。
现在可以让 Claude Code 或 Codex 读取站点上下文、提出变更计划并创建 预览,无需向智能体提供生产凭据。
4. 进行第一个更改
在 Showly 聊天面板或智能体中输入:
把首页主标题改为“发布无需繁琐流程”
智能体会:
- 调用
get_site_context读取相关文件。 - 调用
create_change_plan生成变更计划。 - 调用
apply_site_patch在 Showly 管理的工作区中暂存编辑。 - 调用
create_preview构建并生成预览 URL。
构建完成后(通常在 90 秒内),您将在聊天中看到预览 URL。
5. 批准并发布
打开预览 URL 并检查差异。确认无误后点击请求发布,Showly 会创建 待审批请求;满足工作区审批策略后,才可将预览提升到生产环境。
批准后,Showly 将同一个预览构件提升到生产环境。新的线上 URL 会显示 在发布面板中。
接下来是什么
- 端到端 MCP 流程 — 用具体工具调用展示完整流程。
- 你的第一个站点 — 深入了解 GitHub 仓库接入。
- 架构 — 查看每个组件在幕后的作用。
- MCP 工具参考 — 查看智能体可以调用的全部工具。