Middleman-GH-Pages 项目教程

Middleman-GH-Pages 项目教程

middleman-gh-pagesEasy deployment of Middleman sites to Github Pages项目地址:https://gitcode.com/gh_mirrors/mi/middleman-gh-pages

1. 项目的目录结构及介绍

Middleman-GH-Pages 项目的目录结构通常遵循 Middleman 框架的标准结构。以下是一个典型的 Middleman 项目的目录结构：

my_project/
├── config.rb
├── Gemfile
├── Gemfile.lock
├── source/
│   ├── images/
│   ├── javascripts/
│   ├── layouts/
│   ├── stylesheets/
│   └── index.html.erb
└── build/

目录介绍：

• config.rb：项目的配置文件，包含 Middleman 的设置和选项。
• Gemfile 和 Gemfile.lock：定义项目所需的 RubyGems 及其版本。
• source/：包含项目的源文件，如 HTML、CSS、JavaScript 和布局文件。
  • images/：存放图片文件。
  • javascripts/：存放 JavaScript 文件。
  • layouts/：存放布局模板文件。
  • stylesheets/：存放 CSS 文件。
  • index.html.erb：主页的 ERB 模板文件。
• build/：构建后的静态网站文件，由 Middleman 自动生成。

2. 项目的启动文件介绍

Middleman-GH-Pages 项目的启动文件主要是 config.rb 和 Gemfile。

config.rb

config.rb 是 Middleman 项目的主要配置文件，包含项目的各种设置和选项。以下是一个简单的 config.rb 示例：

# 启用 livereload
activate :livereload
 
# 设置构建目录
set :build_dir, 'build'
 
# 设置相对路径
set :relative_links, true
 
# 其他配置选项...

Gemfile

Gemfile 定义了项目所需的 RubyGems 及其版本。以下是一个简单的 Gemfile 示例：

source 'https://rubygems.org'
 
gem 'middleman'
gem 'middleman-gh-pages'
gem 'sass'
gem 'compass'

3. 项目的配置文件介绍

Middleman-GH-Pages 项目的配置文件主要是 config.rb，它包含了项目的各种配置选项。以下是一些常见的配置选项：

基本配置

# 设置项目标题
set :site_title, 'My Middleman Site'
 
# 设置构建目录
set :build_dir, 'build'
 
# 启用 livereload
activate :livereload

部署配置

Middleman-GH-Pages 提供了一些特定的部署配置选项：

# 启用 middleman-gh-pages 扩展
activate :deploy do |deploy|
  deploy.build_before = true
  deploy.method = :git
  deploy.remote = 'origin'
  deploy.branch = 'gh-pages'
end

其他配置

# 设置相对路径
set :relative_links, true
 
# 启用 gzip 压缩
activate :gzip
 
# 启用 asset_hash
activate :asset_hash

通过这些配置选项，可以灵活地调整 Middleman-GH-Pages 项目的行为和输出。

middleman-gh-pagesEasy deployment of Middleman sites to Github Pages项目地址:https://gitcode.com/gh_mirrors/mi/middleman-gh-pages