Middleman Favicon Maker 使用指南

本文档旨在帮助用户安装、配置和使用 Middleman Favicon Maker 插件，以生成不同尺寸的 favicon 文件。

1. 安装指南

在开始使用 Middleman Favicon Maker 之前，您需要安装 ImageMagick。在 macOS 上，可以通过以下命令安装：

brew install imagemagick

接着，在您的 Middleman 项目中添加以下依赖：

gem "middleman-favicon-maker", "~> 4.1"

如果您使用的是 Middleman 2.x 版本，请使用 middleman-favicon-maker 的 0.0.6 版本。

2. 项目使用说明

Middleman Favicon Maker 需要一个基础图像文件来生成不同尺寸的 favicon。创建一个名为 _favicon_template.png 的图像文件，并放置在源目录中。在配置文件 config.rb 中，扩展 configure :build 块来指定图标生成选项。

简单配置

以下配置假设您已经在源文件夹中有一个名为 _favicon_template.png 的 PNG 文件。生成的图标将存储在构建目录的根目录中。

configure :build do
  ...
  activate :favicon_maker, :icons => {
    "_favicon_template.png" => [
      { icon: "apple-touch-icon-152x152-precomposed.png" },
      { icon: "apple-touch-icon-114x114-precomposed.png" },
      { icon: "apple-touch-icon-72x72-precomposed.png" },
    ]
  }
  ...
end

高级配置

以下是使用所有配置选项的示例。template_dir 和 output_dir 指定源目录和构建目录，可以是绝对路径或相对路径。您可以使用多个模板文件以适应不同的分辨率。format 和 size 是可选的，只有当图标尺寸和/或文件格式没有编码在文件名中时才需要。

configure :build do
  ...
  activate :favicon_maker do |f|
    f.template_dir  = 'source/images'
    f.icons = {
      "_favicon_template_hires.png" => [
        { icon: "apple-touch-icon-152x152-precomposed.png" },
        { icon: "apple-touch-icon-114x114-precomposed.png" },
        { icon: "apple-touch-icon-72x72-precomposed.png" },
        { icon: "mstile-144x144", format: :png },
      ],
      "_favicon_template_lores.png" => [
        { icon: "favicon.png", size: "16x16" },
        { icon: "favicon.ico", size: "64x64,32x32,24x24,16x16" },
      ]
    }
  end
  ...
end

3. 项目API使用文档

Middleman Favicon Maker 的主要方法是 activate :favicon_maker，它接受一个配置哈希，其中包含图标生成的详细信息。

• template_dir: 指定模板文件所在的目录。
• output_dir: 指定输出文件所在的目录。
• icons: 一个哈希，其中的键是模板文件的名称，值是一个包含图标配置的数组。

每个图标配置可以包含以下选项：

• icon: 生成的图标文件的名称。
• size: 图标的尺寸，格式为 "宽度x高度"。
• format: 图标的文件格式。

4. 项目安装方式

Middleman Favicon Maker 可以通过 Bundler 安装。在您的 Middleman 项目的 Gemfile 中添加以下行：

gem "middleman-favicon-maker", "~> 4.1"

然后运行以下命令安装依赖：

bundle install

确保在修改 config.rb 文件并添加相关配置后，重新启动 Middleman 服务器以使更改生效。

以上就是 Middleman Favicon Maker 的安装和使用说明。如果您在使用过程中遇到任何问题，请查阅项目文档或提交问题。