边缘开发者平台
  • Pages
    • 产品简介
    • 快速开始
      • 导入 Git 仓库
      • 从模板开始
      • 直接上传
    • 框架指南
    • 项目指南
      • 项目管理
      • edgeone.json
      • 错误码
    • 构建指南
    • 部署指南
      • 概览
      • 触发部署
      • 管理部署
      • 部署按钮
    • 域名管理
      • 概览
      • 自定义域名
      • 配置 HTTPS 证书
      • 如何配置 DNS 的 CNAME 记录
    • Pages Functions
    • KV 存储
    • 边缘 AI
    • EdgeOne CLI
    • Pages MCP
    • 最佳实践
      • 1 分钟快速部署 + 免费公测中｜你的专属 DeepSeek，EdgeOne 承包了！
      • 将 WordPress Gastby 部署到 EdgeOne Pages
      • 使用 WordPress + GatsbyJS 搭建电商平台
      • 结合 Sanity 部署作品集模板
    • 迁移指南
      • 从 Vercel 迁移至 EdgeOne Pages
      • 从 Cloudflare Pages 迁移至 EdgeOne Pages
      • 从 Netlify 迁移至 EdgeOne Pages
    • 常见问题
    • 联系我们
    • 产品动态
解锁 1年EdgeOne + 1TB CDN： 加入我们的开发者之旅
立即开始！
当前为国际站中文文档，如需访问中国站文档，请点击这里
文档概览/
边缘开发者平台/
Pages/
部署指南/
部署按钮/

部署按钮

本小节将介绍如何在 GitHub 仓库中添加一键部署按钮，让用户能够快速将您的模板部署到 EdgeOne Pages。


部署按钮

Pages 部署按钮如下所示：

使用 EdgeOne Pages 部署


当用户点击此按钮时，他们将被引导至 Pages，并预先配置您的仓库作为部署源。


如何添加部署按钮

将以下 markdown 代码添加到您仓库的 README.md 文件中：
[![使用 EdgeOne Pages 部署](https://cdnstatic.tencentcs.com/edgeone/pages/deploy.svg)](https://edgeone.ai/pages/new?repository-url=YOUR_REPO_URL)

将 YOUR_REPO_URL 替换为您的 GitHub 仓库 URL，支持子路径。例如：
[![使用 EdgeOne Pages 部署](https://cdnstatic.tencentcs.com/edgeone/pages/deploy.svg)](https://edgeone.ai/pages/new?repository-url=https%3A%2F%2Fgithub.com%2FTencentEdgeOne%2Fpages-templates%2Ftree%2Fmain%2Fexamples%2Fvue-template)


URL Search 参数

部署按钮 URL 支持以下 Search 参数：
Search 参数名称
描述
template
通过 Pages 官方模板来部署的模板名称
repository-name
Github 仓库名称
repository-url
通过其他 GitHub 仓库来部署的仓库地址
project-name
项目名称
build-command
构建命令
install-command
安装命令
output-directory
构建后产物的输出目录
root-directory
构建根目录
env
仓库必要的环境变量，如需多个可用英文逗号连接，如：KEY1,KEY2,KEY3
env-description
跟环境变量相关的描述
env-link
跟环境变量相关的链接

注意：
参数值需使用 encodeURIComponent() 编码后再拼接进 URL，如 build-command=npm%20run%20build


示例

对于公共 GitHub 仓库：
[![使用 EdgeOne Pages 部署](https://cdnstatic.tencentcs.com/edgeone/pages/deploy.svg)](https://edgeone.ai/pages/new?repository-url=https%3A%2F%2Fgithub.com%2Fusername%2Frepository)

对于特定分支：
[![使用 EdgeOne Pages 部署](https://cdnstatic.tencentcs.com/edgeone/pages/deploy.svg)](https://edgeone.ai/pages/new?repository-url=https%3A%2F%2Fgithub.com%2Fusername%2Frepository%2Ftree%2Fbranch-name)

如何使用 URL Search 参数：
[![使用 EdgeOne Pages 部署](https://cdnstatic.tencentcs.com/edgeone/pages/deploy.svg)](https://edgeone.ai/pages/new?repository-url=https%3A%2F%2Fgithub.com%2FTencentEdgeOne%2Fpages-templates%2Ftree%2Fmain%2Fexamples%2Fvue-template&output-directory=.%2Fdist&install-command=npm%20install&build-command=npm%20run%20build)


用户体验

当用户点击部署按钮时：

1. 页面将被重定向到 Pages 控制台
2. GitHub 仓库将被作为默认的部署源
3. 支持调整项目的配置项
4. 点击“立即创建”后，项目就会被部署至 Pages

这为想要快速尝试或部署您模板的用户提供了无缝的体验。


更多配置

参考 edgeone.json 文档，您可以自定义项目的构建命令(buildCommand)、依赖安装命令(installCommand) 以及输出目录(outputDirectory)。建议根据项目实际情况配置这些参数，以确保其他人能够正确构建和部署您的项目。