クイックリファレンス

Middleman 3 チートシート

Middleman v3クイックリファレンス:静的サイトジェネレータの設定、Compass連携、アセットパイプライン、レイアウト設定、ビルド最適化。

· 公開日

[!NOTE] アーカイブされたバージョン: このチートシートは Middleman v3 を対象としています。新しい環境では Middleman v4+ の公式ドキュメントを参照してください。

Middleman は、モダンなWeb開発のベストプラクティスを取り入れたRuby製の静的サイトジェネレータです。

設定 (config.rb)

ディレクトリとアセット設定

set :css_dir, "stylesheets"
set :js_dir, "javascripts"
set :images_dir, "images"

# image_tag ヘルパーで画像の縦横サイズを自動付与
activate :automatic_image_sizes

Compass の統合

compass_config do |config|
  config.output_style = :compact
end

ページルーティングとレイアウト

# 生のHTMLやXMLテンプレートでレイアウトを無効化
page "/sitemap.xml", layout: false

# 個別の代替レイアウトを指定
page "/admin/*", layout: :admin_layout

# 複数パスをまとめて1つのレイアウトに指定
with_layout :docs do
  page "/guides/*"
  page "/api/*"
end

# テンプレートを用いたプロキシページの生成
page "/about.html", proxy: "/template-page.html" do
  @page_title = "About Us"
end

カスタムヘルパー

helpers do
  def format_currency(amount)
    "$%.2f" % amount
  end
end

ビルド設定

middleman build 実行時のみアセットを最適化:

configure :build do
  activate :minify_css
  activate :minify_javascript
  activate :cache_buster
  activate :relative_assets

  # アセットのURLプレフィックスにCDNを指定
  # set :http_path, "https://cdn.example.com/"
end

参考資料

関連テーマ