[Jekyll] HTMLを読みやすいように整形するプラグイン

Jekyll で include を多用してると、include されたファイルの中に include があってまたそのファイルの中に include が……なんてことになって HTML の構造が分からなくなるときがあります。 できあがった HTML をみてもインデントがメチャクチャでわけがわからない…！

そこで、HTML を整形して出力するプラグインを作ってみました。 いわゆるbeautifierとかpretty printとかいわれる機能ですね。

require 'rubygems'
require 'htmlbeautifier'

Jekyll::Hooks.register :documents, :post_render do |page|
  next if page.output_ext != '.html'
  page.output = HtmlBeautifier.beautify(page.output)
end

Jekyll::Hooks.register :pages, :post_render do |page|
  next if page.ext != '.html'
  page.output = HtmlBeautifier.beautify(page.output)
end

gem install htmlbeautifier などで htmlbeautifier をインストールしたあと、 このファイルを _plugins フォルダに入れれば Jekyll でのビルド時に HTML が整形されます。

プラグインなので、プラグインが使えない GitHub Pages 上でのビルドには使えません。 あらかじめローカルの環境でビルドして生成されたファイルをアップロードしてください。