Middleman Deploy 部署指南

Middleman Deploy 部署指南

middleman-deploy Deploy a middleman built site over rsync, ftp, stfp, or git (e.g. gh-pages on github). 项目地址: https://gitcode.com/gh_mirrors/mi/middleman-deploy

Middleman Deploy 是一个用于部署由 Middleman 构建的站点到远程服务器的工具，支持通过 rsync、FTP、SFTP 或者 Git（例如 GitHub Pages）的方式进行部署。本指南将帮助您了解项目的基本结构、关键文件及其配置方法。

1. 项目目录结构及介绍

Middleman Deploy 的仓库本身并不直接展示一个典型的 Middleman 应用的目录结构，但它提供了gem的源代码和配置示例。一个标准的、使用了 Middleman Deploy 的 Middleman 项目可能会具有以下结构：

my-middleman-project/
├── config.rb         # 中心配置文件
├── source/           # 站点源码
├── build/            # 构建后的站点文件存放地（部署前由middleman build命令生成）
├── Gemfile           # 定义项目依赖
└── Rakefile          # 可选，用于定义自定义任务，如自动化部署

# Middleman Deploy 相关配置通常在config.rb中进行。

2. 项目启动文件介绍

主配置文件：config.rb

在 Middleman 项目中，config.rb 文件是核心，它包含了所有关于项目构建和运行时的配置选项。当使用 Middleman Deploy 时，您会在该文件中激活并设置部署扩展。基本示例如下：

activate :deploy do |deploy|
  deploy.method = :rsync   # 使用 rsync 方式部署
  deploy.host = 'yourserver.com'
  deploy.path = '/path/to/your/deployment'
  # 更多可选配置...
end

若您的目标是GitHub Pages，则配置可能更像这样：

activate :deploy do |deploy|
  deploy.method = :git
  deploy.branch = 'gh-pages'
end

其他启动考虑：Gemfile 和 Rakefile

• Gemfile：在这里指定 Middleman Deploy 作为依赖项，例如通过添加 gem 'middleman-deploy', '~> 1.0'。
• Rakefile：可以用来定义额外的任务，比如通过 Rake 自动化部署流程。

3. 项目的配置文件介绍

• config.rb中的部署配置：这是关键的配置区域，决定如何、在哪里以及使用什么方式部署你的站点。包括但不限于部署方法(method)、远程主机地址(host)、路径(path)等。你可以根据需要调整部署插件的详细设置，比如添加SSH认证细节、选择清理远程多余文件选项等。

• 环境特定配置：可以通过环境变量 (ENV['TARGET']) 来设定不同的部署配置，这对于有多个部署目标（如生产与测试环境）尤其有用。

• Git 配置示例：如果使用Git进行部署，还需确保你的系统上已安装Git，并且在配置中正确指定了远程分支和策略（如使用子模块或强制推送）。

记住，每次更改配置后，都需要重新启动或至少重新加载Middleman服务器以使更改生效。

通过上述指南，您应该能够顺利配置和利用 Middleman Deploy 功能，实现网站的高效部署。务必参考官方GitHub页面和文档以获取最新信息和高级配置选项。

middleman-deploy Deploy a middleman built site over rsync, ftp, stfp, or git (e.g. gh-pages on github). 项目地址: https://gitcode.com/gh_mirrors/mi/middleman-deploy