Glynn 技术文档

1. 安装指南

Glynn 是一个 Ruby Gem，安装过程非常简单。确保您已经安装了 Ruby 环境，然后打开终端执行以下命令：

gem install glynn --source http://gemcutter.org

执行成功后，您将在系统中拥有 Glynn 可执行文件。

2. 项目的使用说明

Glynn 允许您通过 FTP 将 Jekyll 支持的博客发送到您的托管服务器。在使用之前，您需要在项目目录中进行一些配置。

配置文件

您可以在 _config.yml 文件中配置博客参数以及 FTP 信息，或者创建一个名为 _glynn.yml 的文件专门存放 FTP 信息。

以下是一个 _config.yml 的示例：

markdown: rdiscount
pygments: true
auto: true

ftp_host: 'dmathieu.com'
ftp_dir: '/web/site/root'
ftp_passive: false

# 可选配置
ftp_port: 21                  # 默认值 21
ftp_username: 'your_user'     # 默认从 stdin 读取
ftp_password: 'your_ftp_pass' # 默认从 stdin 读取
ftp_secure: true              # 默认 false

上传文件

在配置好博客和 FTP 信息之后，进入 Jekyll 项目目录，在控制台中执行以下命令：

glynn

Glynn 会连接到远程服务器，并提示您输入 FTP 登录信息，然后将文件上传到指定的 FTP 目录。

3. 项目 API 使用文档

Glynn 项目作为一个 Ruby Gem，可以通过 Ruby 脚本调用其功能。以下是一个简单的使用示例：

require 'glynn'

# 创建 Glynn 实例
glynn = Glynn.new do |config|
  config.ftp_host = 'dmathieu.com'
  config.ftp_dir = '/web/site/root'
  # 其他配置...
end

# 连接并上传
glynn.connect
glynn.upload

4. 项目安装方式

Glynn 的安装方式如上文所述，通过 Ruby Gem 进行安装。确保您的系统中已安装 Ruby，然后使用以下命令：

gem install glynn --source http://gemcutter.org

这样，您就可以在您的项目中使用 Glynn 进行 FTP 上传了。