文档,打开就能读
产品说明、需求文档、更新日志集中展示。支持 Markdown、代码高亮、图片和目录导航,按需选择对外可见的文档。
A PRODUCT BY SIKILAB
一个链接,展示你的产品。
把产品文档、在线 Demo 和交付文件放在一起。
你专心把东西做好,客户打开链接就能看、能试。
01 / 从完成,到被看见
发方案、约演示、交文件。原本散在聊天记录里的几件事,现在有了共同的入口。
产品说明、需求文档、更新日志集中展示。支持 Markdown、代码高亮、图片和目录导航,按需选择对外可见的文档。
上传构建好的前端页面,或接入已有的演示链接。让对方亲手操作流程,讨论方案时有个共同的参照。
桌面端安装包、压缩包、CLI 包都可以分发。项目密码、访问开关和下载开关,决定这次交付开放哪些内容。
02 / 经常被问到的问题
Git 管研发过程,DemoView 管对外展示。
代码继续留在仓库,把准备好的成果发给客户。
| 你要做的事 | Git / 代码托管平台 | DemoView |
|---|---|---|
| 面向谁 | 开发者与研发协作者 | 客户、朋友和外部体验者 |
| 管理什么 | 源码、提交与分支;托管平台可提供 Issue、PR 和 CI | 对外文档、在线 Demo、外部演示链接与安装包 |
| 解决什么 | 记录变更,协作开发,追踪代码如何迭代 | 让对方阅读说明、体验产品、下载开放的交付文件 |
| 怎样搭配 | 在原来的仓库里继续工作 | 通过后台或 CLI 发布选定的内容 |
Git 托管平台也可以承载文档、发布包和静态站点。DemoView 把这些对外入口集中在项目页面里,方便不参与研发的人访问;它不提供 Git 的版本控制能力。
03 / 接上你的 AI 工作流
你或 AI 助手在本地更新文档、完成 Demo 后,可以调用 DemoView CLI 发布选定的内容,省去反复打开后台上传。
先登录并绑定项目,配置好同步范围。发布前用 demoview diff 检查变化,确认后执行 demoview sync。
# 安装 CLI
npm install -g "https://demo.sikilab.com/api/projects/sdc/demo-package?demo=cli"
# 登录,进入你的本地项目目录后绑定
demoview login
demoview bind --project YOUR_PROJECT_CODE
# 检查变化,再同步
demoview diff
demoview syncYOUR_PROJECT_CODE 替换为你的项目编码。首次同步前配置好文档和 Demo 路径。
04 / 开始发布
整理文档、构建好的前端 Demo,或已有的在线演示地址。
在后台管理项目内容,也可以用 CLI 从本地项目同步。
选择对外文档,按需设置项目密码、访问和下载权限。
客户从同一个项目入口阅读、体验。内容更新后继续使用这个入口。
05 / 使用之前
可以。按项目实际内容发布即可,不要求同时准备文档、Demo 和安装包。
不需要。客户打开项目链接就能阅读文档和进入演示;如果项目设置了密码,需要先输入密码。
这里的在线预览面向构建好的前端 HTML、CSS 和 JavaScript。需要数据库或后端服务的产品,应另行部署服务,再把可访问的地址作为外部演示链接加入项目。
发布范围由你配置。使用 CLI 时指定文档和 Demo 路径,并在同步前检查差异。不要把密钥、环境配置或不应公开的客户资料加入同步范围。
目前重点是内容发布和对外展示。文档在本地编写后上传或同步,复杂多人审批与在线文档编辑不在当前介绍的功能范围内。
从“开始使用”进入平台。账号开通、收费及容量限制请以平台当前说明为准;有不清楚的地方,可以发邮件到 hello@sikilab.net 询问。