参考指南
添加组件
本文档介绍如何在您的站点中安装 Blocklet,并说明不同安装方式的特点、适用场景及注意事项。
Blocklet 提供三种安装方式:
- 通过 Store 安装
- 通过 URL 安装
- 本地上传安装


1. 通过 Store 安装#
此方式最为简单,适合新手或希望快速安装官方推荐 Blocklet 的用户。
操作步骤:
- 点击「添加 Blocklet」。
- 在当前页面会弹出官方 Blocklet Store。
- 在 Store 中搜索需要的 Blocklet,例如
Static Demo、Pages Kit等。 - 点击「下一步」,继续您的安装过程。

2. 通过 URL 安装#
如果您已有合法的 blocklet.json 地址,可以直接通过 URL 安装。
- 支持的地址类型:
- 远程地址:例如
https://example.com/blocklet.json - 本地地址:例如
file:///Users/xxx/blocklet/blocklet.json
- 远程地址:例如
使用步骤:
- 选择「从 URL 添加 Blocklet」。
- 输入合法的
blocklet.json地址。您也可在官方提供的 store 站点,复制 blocklet 的安装 URL - 系统验证成功后,点击「下一步」会继续您的安装过程,其他步骤和通过 store 安装相同。
- 通过 URL 安装的 blocklet 会把安装 URL 记录,在下拉菜单中显示,方便下次快速安装和升级。

⚠️ 注意:
- 必须确保该地址可访问。
- 提供的
blocklet.json文件需符合 Blocklet 规范,否则安装会失败。
3. 本地上传安装#
此方式允许您直接上传本地文件,适合测试或未发布到 Store 的 Blocklet。
- 支持文件类型:
- 静态文件:
html,htm - 压缩包:
zip,tgz
- 静态文件:
- 上传内容要求:
- 如果是静态文件,必须包含
index.html或index.htm作为入口文件。 - 压缩包的内容可以是纯静态文件或者是已打包好的blocklet。在上传是系统会自动识别项目类型
- 如果是静态文件,必须包含
上传成功后会自动进入安装流程

挂载点与覆盖规则#
安装完成后,您需要为 Blocklet 配置 挂载点:
- 挂载点定义:Blocklet 在站点中的访问路径,例如:
/blog→ 通过https://your-site.com/blog访问/forum→ 通过https://your-site.com/forum访问
- 覆盖规则:
- 如果新安装的 Blocklet 使用了与已有 Blocklet 相同的挂载点,新内容会 覆盖(override) 旧内容。
- 挂载点相同只会覆盖通过上传安装的 blocklet,如果和其他形式安装的 blocklet 相同,会生成一个默认的挂载点不会进行覆盖
- 建议在安装时选择唯一的挂载点,避免与现有服务冲突。
- 当您想要升级上传安装的 blocklet 时,可以通过挂载点覆盖的模式进行升级,不需要卸载重新安装
