surge.yaml

安装 Surge

在 Mac 上安装 Surge 可以通过以下方式：

• 使用 Homebrew：

  brew install surge

• 下载并安装 dmg 文件：
  • 访问 Surge 官网
  • 下载适用于你的 Mac 版本的 dmg 文件
  • 双击安装 dmg 文件

---

初始化 Surge

运行 Surge 后，会自动生成一个默认的 surge.yaml 配置文件,用户可以根据需要修改配置。

  # 项目目录
  directory: ./src
  # 构建规则
  rule:
    - name: index
      pattern: 200*.html
    - name: about
      pattern: about*.html
    - name: blog
      pattern: blog*.html
  # 构建命令
  command: npm run build
  # 输出目录
  to: ./dist
# 部署规则
deploy:
  - name: production
    url: https://your-site.surge.sh
    # 静态文件目录
    from: ./dist

---

配置本地开发

• 工作目录：在 build 部分设置为项目目录，directory: ./src。
• 静态文件路径：在 to 部分设置为构建后的目录，to: ./dist。

---

配置部署规则

在 deploy 部分设置你的部署规则，

deploy:
  - name: production
    url: https://your-site.surge.sh
    from: ./dist

• url：你的 Surge 网站地址。
• from：构建后的文件路径。

---

启用自动化构建

如果你想自动化构建，可以在 build 部分添加构建命令：

build:
  command: npm run build

---

配置路由规则

Surge 支持动态路由转换为静态文件路径。

route:
  /about: about.html
  /blog/:id: blog/:id.html

---

使用 CI 工具

如果你使用 CI 工具（如 GitHub Actions），可以在 .gitlab-ci.yml 或 .travis.yml 中配置 Surge 的部署规则。

---

常见错误

• 权限问题：确保 Surge 有权限读取和写入文件。
• 构建失败：检查 build 命令是否正确。
• 部署失败：检查网络连接和 Surge 的配置是否正确。

---

更多配置

• 如果你的项目使用框架（如 Next.js），可以参考 Surge 的官方文档。
• 如果你需要更多定制化规则，可以参考 Surge 的路由和配置。